From 4b292ca1426c59b3124a0849a4b1c285b5196406 Mon Sep 17 00:00:00 2001
From: serinko <97586125+serinko@users.noreply.github.com>
Date: Tue, 25 Nov 2025 10:02:28 +0100
Subject: [PATCH] update nym-node-cli guide
---
.../outputs/api-scraping-outputs/time-now.md | 2 +-
.../node-api-check-query-help.md | 2 +-
.../nym-node-cli-install-help.md | 37 ++++++++++++++
documentation/docs/pages/operators/tools.mdx | 48 ++++++++++++++++++-
.../scripts/next-scripts/python-prebuild.sh | 10 ++++
.../nym-node-setup/network-tunnel-manager.sh | 0
6 files changed, 96 insertions(+), 3 deletions(-)
create mode 100644 documentation/docs/components/outputs/command-outputs/nym-node-cli-install-help.md
mode change 100644 => 100755 scripts/nym-node-setup/network-tunnel-manager.sh
diff --git a/documentation/docs/components/outputs/api-scraping-outputs/time-now.md b/documentation/docs/components/outputs/api-scraping-outputs/time-now.md
index bfd8731655..da40fc5444 100644
--- a/documentation/docs/components/outputs/api-scraping-outputs/time-now.md
+++ b/documentation/docs/components/outputs/api-scraping-outputs/time-now.md
@@ -1 +1 @@
-Thursday, November 20th 2025, 12:33:19 UTC
+Tuesday, November 25th 2025, 08:49:55 UTC
diff --git a/documentation/docs/components/outputs/command-outputs/node-api-check-query-help.md b/documentation/docs/components/outputs/command-outputs/node-api-check-query-help.md
index 999f3d4a6f..bfa068ddb0 100644
--- a/documentation/docs/components/outputs/command-outputs/node-api-check-query-help.md
+++ b/documentation/docs/components/outputs/command-outputs/node-api-check-query-help.md
@@ -11,7 +11,7 @@ options:
--no_routing_history Display node stats without routing history
--no_verloc_metrics Display node stats without verloc metrics
-m, --markdown Display results in markdown format
- -o, --output [OUTPUT]
+ -o [OUTPUT], --output [OUTPUT]
Save results to file (in current dir or supply with
path without filename)
```
diff --git a/documentation/docs/components/outputs/command-outputs/nym-node-cli-install-help.md b/documentation/docs/components/outputs/command-outputs/nym-node-cli-install-help.md
new file mode 100644
index 0000000000..70baf6f736
--- /dev/null
+++ b/documentation/docs/components/outputs/command-outputs/nym-node-cli-install-help.md
@@ -0,0 +1,37 @@
+```sh
+usage: nym-node-cli install [-h] [-V] [-d BRANCH] [-v]
+ [--mode {mixnode,entry-gateway,exit-gateway}]
+ [--wireguard-enabled {true,false}]
+ [--hostname HOSTNAME] [--location LOCATION]
+ [--email EMAIL] [--moniker MONIKER]
+ [--description DESCRIPTION]
+ [--public-ip PUBLIC_IP]
+ [--nym-node-binary NYM_NODE_BINARY]
+ [--uplink-dev UPLINK_DEV] [--env KEY=VALUE]
+
+options:
+ -h, --help show this help message and exit
+ -V, --version show program's version number and exit
+ -d BRANCH, --dev BRANCH
+ Define github branch (default: develop)
+ -v, --verbose Show full error tracebacks
+ --mode {mixnode,entry-gateway,exit-gateway}
+ Node mode: 'mixnode', 'entry-gateway', or 'exit-
+ gateway'
+ --wireguard-enabled {true,false}
+ WireGuard functionality switch: true / false
+ --hostname HOSTNAME Node domain / hostname
+ --location LOCATION Node location (country code or name)
+ --email EMAIL Contact email for the node operator
+ --moniker MONIKER Public moniker displayed in explorer & NymVPN app
+ --description DESCRIPTION
+ Short public description of the node
+ --public-ip PUBLIC_IP
+ External IPv4 address (autodetected if omitted)
+ --nym-node-binary NYM_NODE_BINARY
+ URL for nym-node binary (autodetected if omitted)
+ --uplink-dev UPLINK_DEV
+ Override uplink interface used for NAT/FORWARD (e.g.,
+ 'eth0'; autodetected if omitted)
+ --env KEY=VALUE (Optional) Extra ENV VARS, e.g. --env CUSTOM_KEY=value
+```
diff --git a/documentation/docs/pages/operators/tools.mdx b/documentation/docs/pages/operators/tools.mdx
index 8a801e526a..c1b2eb6df8 100644
--- a/documentation/docs/pages/operators/tools.mdx
+++ b/documentation/docs/pages/operators/tools.mdx
@@ -5,7 +5,13 @@ import { RunTabs } from 'components/operators/nodes/node-run-command-tabs';
import { VarInfo } from 'components/variable-info.tsx';
import { AccordionTemplate } from 'components/accordion-template.tsx';
import { Steps } from 'nextra/components';
+import NymNodeCliInstallHelp from 'components/outputs/command-outputs/nym-node-cli-install-help.md';
+export const NymNodeCliCommand = () => (
+
+ Arguments and options: ./nym-node-cli.py install --help
+
+);
# Tools
@@ -45,10 +51,50 @@ chmod +x ./nym-node-cli.py
```
###### 3. Run the program
+
+There are two ways how to run the program. fully interactive or with provided arguments. The former has a shorter initial command but then operators must fill the values on the go, the latter requires more complex command, but then there is a minimum prompts during the process.
+
+1. Fully interactive mode - just run:
```
-./nym-node-cli.py
+./nym-node-cli.py install
```
+
+2. Use arguments - this command to see all options:
+```sh
+./nym-node-cli.py install --help
+```
+}>
+
+
+- An example can look like this:
+```sh
+# substitute with your real values:
+ ./nym-node-cli.py install
+ --hostname node-install.devrel.nymte.ch
+ --moniker MainnetGW-DE
+ --description "This node is installed with nym-node-cli v1.2.0"
+ --wireguard-enabled true
+ --location DE
+ --mode exit-gateway
+ --email kawa_hesinkar@example.ku
+```
+
###### 4. Read and follow the prompts
+
+There will be a few needed confirmations and in caser of running the program without the arguments, you will be prompted for values neccessary to setup a `nym-node` and configure your server.
+
+**Read these prompts carefully!**
+
+###### 5. Setup finished
+
+Congratulation, your node is installed.
+
+This version of the program does not prompt an operator for the local node moniker (`--id `) therefore it asigns your node an automatic one `default-nym-node`.
+
+All configuration and data of your node can be found in this location:
+```sh
+ls $HOME/.nym/nym-nodes/default-nym-node/
+```
## CMD Reward Tracker
diff --git a/documentation/scripts/next-scripts/python-prebuild.sh b/documentation/scripts/next-scripts/python-prebuild.sh
index a78bfbf11e..9083b2fd57 100755
--- a/documentation/scripts/next-scripts/python-prebuild.sh
+++ b/documentation/scripts/next-scripts/python-prebuild.sh
@@ -59,4 +59,14 @@ echo '```sh' > ../../documentation/docs/components/outputs/command-outputs/nym-a
./nym-api --help >> ../../documentation/docs/components/outputs/command-outputs/nym-api-help.md &&
echo '```' >> ../../documentation/docs/components/outputs/command-outputs/nym-api-help.md &&
+cd ../../scripts/nym-node-setup
+
+echo '```sh' > ../../documentation/docs/components/outputs/command-outputs/nym-node-cli-install-help.md &&
+python ./nym-node-cli.py install --help >> ../../documentation/docs/components/outputs/command-outputs/nym-node-cli-install-help.md &&
+echo '```' >> ../../documentation/docs/components/outputs/command-outputs/nym-node-cli-install-help.md &&
+
+echo '```sh' > ../../documentation/docs/components/outputs/command-outputs/nym-node-cli-install-help.md &&
+python ./nym-node-cli.py install --help >> ../../documentation/docs/components/outputs/command-outputs/nym-node-cli-install-help.md &&
+echo '```' >> ../../documentation/docs/components/outputs/command-outputs/nym-node-cli-install-help.md &&
+
echo "prebuild finished"
diff --git a/scripts/nym-node-setup/network-tunnel-manager.sh b/scripts/nym-node-setup/network-tunnel-manager.sh
old mode 100644
new mode 100755