Skip to main content
The commands that manage the CLI itself rather than a NeetoForm resource.

​
login

Signs in to a workspace through the browser and stores the credential.
Without --subdomain the command prompts for it. It waits up to five minutes for you to finish in the browser, and prints the URL in case the browser does not open. Running it again for a workspace you are already signed in to refreshes that entry. See Authentication. This command takes no flags of its own.

​
logout

Removes a stored credential.
With exactly one workspace signed in, neetoform logout on its own removes it. With several it refuses and asks you to choose, so nothing is dropped by accident.

​
whoami

Lists the workspaces you are signed in to.
(default) appears only when exactly one workspace is signed in, which is the case where --subdomain can be left off. neetoform whoami --subdomain acme shows just that one. This command takes no flags of its own.

​
doctor

Checks the credential, reaches the API and reports the installed version.
Each check runs independently, so a failing credential still tells you whether the API is reachable. With no credential and no --subdomain, the connection check is skipped rather than guessed at. The command exits 0 even when a check fails, so read the report rather than the exit code. This command takes no flags of its own.

​
version

Prints the version, the commit it was built from and the build date.
This command takes no flags of its own.

​
update

Upgrades the CLI in place.
It works out how the running binary was installed and upgrades it the same way: a binary inside a Homebrew Cellar is upgraded with brew upgrade, anything else on macOS or Linux is upgraded by re-running the shell install script, and on Windows it always re-runs the PowerShell install script. The CLI starts powershell itself on Windows, so you can run neetoform update from Command Prompt, Git Bash or PowerShell. It prints the method it detected and the command it runs before running it, and exits non-zero if the download or the installer fails. This command takes no flags of its own.

​
commands

Prints every command and flag as JSON.
Each entry has command, description, flags where the command declares any and subcommands where it has any. A flag always carries name, type and description; default appears only when the flag has one, and required appears only on flags that must be passed, as "required": true. The global flags, help, completion and commands itself are left out. The catalog is what an AI assistant reads to learn a flag the instruction file does not cover, and the commands overview on this site is generated from it. This command takes no flags of its own.

​
setup

Installs NeetoForm instructions into an AI coding assistant.
Everything except claude writes into the current directory, so run it from the project root. Run the command again after upgrading, since the instructions are built into the binary. See AI assistants for what each target writes and how a re-run treats an existing file. These commands take no flags of their own.

​
Shell completion

neetoform completion <shell> writes the completion script under ~/.config/neetoform/completions and wires your shell to load it on the next start. There is nothing to source by hand.
Start a new shell to use it. zsh, bash and powershell add a marked block to ~/.zshrc, ~/.bashrc or your PowerShell profile; re-running replaces that block rather than duplicating it. fish writes to ~/.config/fish/completions/neetoform.fish, which fish loads on its own. Re-run the command after upgrading. The script is generated from the commands the binary has, so an old script will not complete new ones. Pass --print to write the script to standard output instead of installing it, which is what you want when a package manager or dotfiles repo owns the file: