Skip to content

A modern and elegant dashboard for network traffic visualization and analysis.

feat: Implement `remove` and `uninstall` commands for agent management and enhance `install.sh` with intro, plan, and binary symlinking.

luolei3ebcf443635f
diff --git a/apps/agent/README.md b/apps/agent/README.md
index 5d267e1..2963748 100644
--- a/apps/agent/README.md
+++ b/apps/agent/README.md
@@ -60,6 +60,8 @@ nekoagent status backend-1
nekoagent logs backend-1
nekoagent restart backend-1
nekoagent update backend-1 agent-v1.3.2
+nekoagent remove backend-1
+nekoagent uninstall
```
Pin release version (recommended for production):
diff --git a/apps/agent/install.sh b/apps/agent/install.sh
index a317156..7d211d5 100755
--- a/apps/agent/install.sh
+++ b/apps/agent/install.sh
@@ -10,6 +10,44 @@ require_env() {
fi
}
+show_intro() {
+ cat <<'EOF'
+╔════════════════════════════════════════════════════════════╗
+║ Neko Master Agent ║
+╚════════════════════════════════════════════════════════════╝
+
+Neko Master is a centralized traffic analytics panel.
+Agent runs near your local gateway and reports data securely to the panel.
+
+Project:
+ https://github.com/foru17/neko-master
+
+Agent docs:
+ https://github.com/foru17/neko-master/tree/main/docs/agent
+
+EOF
+}
+
+show_plan() {
+ token_mode="not set"
+ if [ -n "$NEKO_GATEWAY_TOKEN" ]; then
+ token_mode="provided"
+ fi
+
+ cat <<EOF
+[neko-agent] install plan:
+ target: ${os}/${arch}
+ version: ${NEKO_AGENT_VERSION}
+ backend id: ${NEKO_BACKEND_ID}
+ instance: ${NEKO_INSTANCE_NAME}
+ gateway type: ${NEKO_GATEWAY_TYPE}
+ gateway url: ${NEKO_GATEWAY_URL}
+ gateway token: ${token_mode}
+ install dir: ${NEKO_INSTALL_DIR}
+ auto start: ${NEKO_AUTO_START}
+EOF
+}
+
download_file() {
url="$1"
output="$2"
@@ -75,6 +113,8 @@ require_env "NEKO_BACKEND_ID"
require_env "NEKO_BACKEND_TOKEN"
require_env "NEKO_GATEWAY_URL"
+show_intro
+
NEKO_GATEWAY_TYPE="${NEKO_GATEWAY_TYPE:-clash}"
NEKO_GATEWAY_TOKEN="${NEKO_GATEWAY_TOKEN:-}"
NEKO_AGENT_REPO="${NEKO_AGENT_REPO:-foru17/neko-master}"
@@ -83,6 +123,8 @@ NEKO_PACKAGE_URL="${NEKO_PACKAGE_URL:-}"
NEKO_CHECKSUMS_URL="${NEKO_CHECKSUMS_URL:-}"
NEKO_CLI_URL="${NEKO_CLI_URL:-}"
NEKO_INSTALL_DIR="${NEKO_INSTALL_DIR:-$HOME/.local/bin}"
+NEKO_BIN_LINK_MODE="${NEKO_BIN_LINK_MODE:-auto}"
+NEKO_LINK_DIR="${NEKO_LINK_DIR:-/usr/local/bin}"
NEKO_LOG="${NEKO_LOG:-true}"
NEKO_AUTO_START="${NEKO_AUTO_START:-true}"
NEKO_INSTANCE_NAME="${NEKO_INSTANCE_NAME:-backend-${NEKO_BACKEND_ID}}"
@@ -123,6 +165,8 @@ else
cli_url="https://raw.githubusercontent.com/${NEKO_AGENT_REPO}/${cli_ref}/apps/agent/nekoagent"
fi
+show_plan
+
tmp_dir="${TMPDIR:-/tmp}/neko-agent.$$"
mkdir -p "$tmp_dir"
trap 'rm -rf "$tmp_dir"' EXIT INT TERM
@@ -180,8 +224,30 @@ cli_target="$NEKO_INSTALL_DIR/nekoagent"
mv "$cli_path" "$cli_target"
chmod +x "$cli_target"
-if ! echo ":$PATH:" | grep -q ":$NEKO_INSTALL_DIR:"; then
+linked_to_path="false"
+if [ "$NEKO_BIN_LINK_MODE" != "false" ]; then
+ can_link="false"
+ if [ "$NEKO_BIN_LINK_MODE" = "true" ]; then
+ can_link="true"
+ elif [ -d "$NEKO_LINK_DIR" ] && [ -w "$NEKO_LINK_DIR" ]; then
+ can_link="true"
+ fi
+
+ if [ "$can_link" = "true" ]; then
+ if mkdir -p "$NEKO_LINK_DIR" 2>/dev/null; then
+ if ln -sf "$install_target" "$NEKO_LINK_DIR/neko-agent" 2>/dev/null &&
+ ln -sf "$cli_target" "$NEKO_LINK_DIR/nekoagent" 2>/dev/null; then
+ linked_to_path="true"
+ echo "[neko-agent] linked binaries into: $NEKO_LINK_DIR"
+ fi
+ fi
+ fi
+fi
+
+if [ "$linked_to_path" = "false" ] && ! echo ":$PATH:" | grep -q ":$NEKO_INSTALL_DIR:"; then
echo "[neko-agent] warning: $NEKO_INSTALL_DIR is not in PATH"
+ echo "[neko-agent] hint: use full path: $cli_target status $NEKO_INSTANCE_NAME"
+ echo "[neko-agent] hint: add PATH in shell profile: export PATH=\"$NEKO_INSTALL_DIR:\$PATH\""
fi
"$cli_target" init "$NEKO_INSTANCE_NAME" \
@@ -202,6 +268,8 @@ echo " $cli_target stop $NEKO_INSTANCE_NAME"
echo " $cli_target status $NEKO_INSTANCE_NAME"
echo " $cli_target logs $NEKO_INSTANCE_NAME"
echo " $cli_target update $NEKO_INSTANCE_NAME [agent-vX.Y.Z]"
+echo " $cli_target remove $NEKO_INSTANCE_NAME"
+echo " $cli_target uninstall"
if [ "$NEKO_AUTO_START" = "true" ]; then
"$cli_target" start "$NEKO_INSTANCE_NAME"
diff --git a/apps/agent/nekoagent b/apps/agent/nekoagent
index b4b5b98..7322701 100755
--- a/apps/agent/nekoagent
+++ b/apps/agent/nekoagent
@@ -59,6 +59,9 @@ Usage:
$PROG logs <name> Tail logs
$PROG list List configured instances
$PROG update <name> [version] Update agent binary and restart instance
+ $PROG remove <name> Remove one instance config/runtime data
+ $PROG delete <name> Alias of remove
+ $PROG uninstall Uninstall nekoagent + neko-agent binaries
Config and runtime paths:
CONFIG_DIR=$CONFIG_DIR
@@ -283,6 +286,32 @@ cmd_update() {
log "instance '$name' updated to $version"
}
+cmd_remove() {
+ name="$1"
+
+ if is_running "$name"; then
+ cmd_stop "$name"
+ fi
+
+ rm -f "$(pid_file "$name")"
+ rm -f "$(log_file "$name")"
+
+ cf="$(config_file "$name")"
+ if [ -f "$cf" ]; then
+ rm -f "$cf"
+ fi
+
+ log "instance '$name' removed"
+}
+
+cmd_uninstall() {
+ rm -f "$AGENT_BIN"
+ rm -f "$INSTALL_DIR/nekoagent"
+ rm -f "/usr/local/bin/neko-agent" "/usr/local/bin/nekoagent"
+ log "binaries removed"
+ log "note: instance config files remain in $CONFIG_DIR (use '$PROG remove <name>' if needed)"
+}
+
main() {
if [ "$#" -lt 1 ]; then
usage
@@ -320,6 +349,21 @@ main() {
fi
cmd_update "$@"
;;
+ remove|delete)
+ if [ "$#" -ne 1 ]; then
+ usage
+ exit 1
+ fi
+ cmd_remove "$1"
+ ;;
+ uninstall)
+ if [ "$#" -ne 0 ]; then
+ err "uninstall does not accept instance name; use '$PROG remove <name>'"
+ usage
+ exit 1
+ fi
+ cmd_uninstall
+ ;;
list)
cmd_list
;;
diff --git a/docs/agent/install.md b/docs/agent/install.md
index 5aa96ad..cd65c31 100644
--- a/docs/agent/install.md
+++ b/docs/agent/install.md
@@ -35,6 +35,8 @@ Optional env:
- `NEKO_PACKAGE_URL`: custom package URL override
- `NEKO_CHECKSUMS_URL`: custom checksums URL override
- `NEKO_INSTANCE_NAME`: instance name for `nekoagent` manager (default `backend-<id>`)
+- `NEKO_BIN_LINK_MODE`: `auto|true|false` for symlink into global bin dir (default `auto`)
+- `NEKO_LINK_DIR`: global bin dir for symlink (default `/usr/local/bin`)
After install, manage agent with:
@@ -43,6 +45,13 @@ nekoagent status <instance>
nekoagent logs <instance>
nekoagent restart <instance>
nekoagent update <instance> agent-vX.Y.Z
+nekoagent remove <instance>
+```
+
+Uninstall binaries:
+
+```bash
+nekoagent uninstall
```
## Manual install