Skip to main content
The CLI signs in through the browser. There is no API key to generate or paste, and the credential it stores is a session tied to your own account, so every command runs with your permissions.

Sign in

Leave --subdomain off and the CLI prompts for it. The subdomain is the part of your workspace URL before neetoform.com, so acme for acme.neetoform.com. See Workspace subdomain. The command opens your browser, prints the URL in case it does not open, and waits up to two minutes for you to finish signing in:
Confirm it worked:
doctor runs each check independently, so a failing credential still tells you whether the API is reachable.

Several workspaces at once

login adds an entry rather than replacing one, so you can be signed in to as many workspaces as you like. Which one a command targets depends on how many are signed in:
--subdomain is a global flag, so it works on every command.

Check who you are

With one workspace signed in it names it as the default:
With several, it lists them all. neetoform whoami --subdomain acme shows just one.

Sign out

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. neetoform logout --all removes every entry.

Where credentials are stored

Credentials for every signed-in workspace live together in a single file:
Each entry holds the subdomain, your email and a session token.
A session token acts as you. Treat the file like a password store, keep it out of backups you share, and run neetoform logout --all on a machine you are handing over.

Pointing the CLI at another server

Set NEETOFORM_BASE_URL to reach a staging or local server instead of https://<subdomain>.neetoform.com:

How this differs from the API and MCP