English
nclient commands
nclient drives the client from a terminal and runs from a person's own account. Run as root, every subcommand is rejected with root_refused and exits with status 2. The table lists the subcommands as nclient --help does.
| Command | Arguments and flags | What it does |
|---|---|---|
nclient connect <link> | <link> is the neutrino://enroll/ link from the hub's Clients page, with it omitted, the command prompts for it; --yes replaces an existing binding | Joins the hub the link names. |
nclient disconnect | Leaves the hub. | |
nclient status | Prints what this person is bound to. | |
nclient gui | --hidden starts without showing the window | Runs the client and its window. |
nclient quit | Stops the running client. With none running, it is rejected with resident_not_running. | |
nclient service list | Prints every published entry, nested by kind and numbered. | |
nclient service web open <ref> | <ref> is the entry's number in service list or its id, here and in every row that follows | Opens one link in the browser. |
nclient service port forward <ref> | --local-port <port> | Relays one port to this machine's loopback. |
nclient service port unforward <ref> | Closes that relay. | |
nclient service file config <ref> | --path <path> (required), --username <name>; the password is typed at a prompt | Saves a share's login and path, and mounts it. |
nclient service file mount <ref> | Mounts a share again with its saved login. | |
nclient service file unmount <ref> | Unmounts a share; its saved login stays. | |
nclient service ai show | Prints where this person's tools point. | |
nclient service ai apply hub | --claude-default, --claude-opus, --claude-sonnet, --claude-haiku, --codex-model, --codex-effort (minimal, low, medium, high), --gemini-model; an omitted flag keeps the saved choice, and '' means the gateway default | Points the tools at the gateway. |
nclient service ai apply off | Puts the tools back. | |
nclient service desktop connect <ref> | Opens the viewer at one shared desktop. |
| Flag | Where | What it does |
|---|---|---|
--version | nclient | Prints the package version and exits. |
-h | every level | Prints that level's help and exits. |
nclient with no subcommand, nclient service with no kind, and a kind with no action print their help and exit with status 2.
