Skip to main content
The commands on this page manage the CLI itself rather than a NeetoDesk resource, so none of them have an API-reference counterpart.
Sample output on this page is shown as the --json envelope where a command produces one, and as the plain message otherwise. See Output formats.

​
login

Signs in to a workspace through your browser and saves the session. The CLI prompts for your subdomain unless you pass one.
See Authentication for the full flow and where credentials are stored.

​
logout

Signs out and clears the saved credentials. With one workspace signed in, no flags are needed; with several, name one with --subdomain or clear them all with --all.

​
whoami

Reports which account is signed in, and on which workspace. With several workspaces signed in, it prints one line per workspace; pass --subdomain to show just one.

​
doctor

Checks authentication, connectivity to your workspace and the CLI version. Every check runs independently, so one failure does not hide the next. Start here when something is not working.
A failed check is marked ✗ and followed by the reason. When nothing is signed in, pass --subdomain to probe a workspace anyway; without it the connection check is skipped and marked •.

​
version

Prints the CLI version, commit and build date. Include it when reporting a problem. neetodesk --version prints the same line.
With --json the same fields come back as an object:

​
update

Upgrades the CLI to the latest release by re-running the installer that put it there. The command detects the install method and prints it before it runs:
  • A Homebrew install (the binary lives in a Cellar directory) runs brew update and brew upgrade neetozone/homebrew-tap/neetodesk.
  • On Windows it runs the PowerShell install script.
  • Anywhere else it downloads and runs the shell install script.
There is no way to pin a version; update always moves to the newest release. Re-run neetodesk completion <shell> and any neetodesk setup command afterwards so the completion script and assistant instructions match the new version.

​
setup

Installs NeetoDesk instructions into an AI coding assistant. See AI assistants for what each subcommand writes and where.

​
commands

Prints the full command catalog as JSON: every command, its description, and each flag’s name, type, default and whether it is required. The command reference on this site is generated from its output, and the instructions setup installs tell assistants to read it.
The catalog leaves out commands itself, completion and help, so those three are documented only on this page.

​
Shell completion

neetodesk completion <shell> writes the completion script to disk. For zsh, bash and powershell it also adds a loader block to your shell’s startup file so the script is picked up on the next start; fish loads its completions directory automatically, so there is no startup file to touch. There is nothing to source by hand.
The loader is a block between # neetodesk completions and # end neetodesk completions lines. Re-running the command overwrites the script and replaces that block rather than adding a second one, and leaves the rest of the file untouched. Start a new shell afterwards so the completion script is loaded.
Re-run neetodesk completion <shell> after every upgrade. The installed script lists the commands that existed when it was written, so without a refresh new commands will not complete.
To inspect the script rather than install it, pass --print and it goes to standard output instead: