Skip to main content

​
Start with doctor

neetodesk doctor checks each thing independently and reports all of them, so one failure does not hide the next:
A failing check is marked ✗ and followed by the reason. When no workspace is signed in the connection check is skipped unless you pass --subdomain, which lets you confirm a workspace is reachable before signing in.

​
Reading an API error

When the API rejects a request, the CLI reports the status code, the message the API returned and a suggestion, then exits with status 1:
Other statuses print the message with no suggestion. When the API returns several validation errors, the first is the message and the rest follow as indented - lines.

​
Common problems

Problem: No workspace is signed in on this machine.
Solution: Run neetodesk login. See Authentication.
Problem: You are signed in to more than one workspace, so the CLI will not guess which one you meant.
Solution: Add --subdomain acme to the command, or drop the workspaces you no longer need with neetodesk logout --subdomain globex.
Problem: The subdomain you passed is not among the ones signed in. The message lists the ones that are.
Solution: Check the spelling of the subdomain, then run neetodesk login --subdomain acme.
Problem: neetodesk login could not find a workspace at the subdomain you typed.
Solution: Enter only the first label of your workspace URL: acme for acme.neetodesk.com. See Workspace subdomain.
Problem: The browser sign-in was started but not completed before the sign-in link expired.
Solution: Run neetodesk login again and finish the sign-in in the browser it opens.
Problem: The CLI waited two minutes for the browser to confirm the sign-in and gave up.
Solution: Run neetodesk login again. If the browser did not open, paste the URL the CLI printed after “If the browser doesn’t open, visit:” into a browser yourself.
Problem: The saved session token expired.
Solution: Run neetodesk login to sign in again. The stored credential is replaced.
Problem: The CLI could not reach the host at all, rather than being turned away by it. The underlying network error follows the colon. A proxy or VPN is the usual cause.
Solution: Run neetodesk doctor to see which host it is trying, and confirm you can reach that host in a browser.
Problem: A flag the command needs was left out. The CLI prints the error followed by Run 'neetodesk --help' for usage. and exits with status 1. The same happens for an unknown command, an unknown flag or a missing positional argument.
Solution: Run neetodesk <command> --help; required flags are marked in the command reference flag tables.
Problem: The directory the CLI was installed to is not on your PATH.
Solution: On macOS and Linux the install script puts the binary in /usr/local/bin, which is on the default PATH; check that your shell has not overridden it. On Windows the installer adds %LOCALAPPDATA%\Programs\neetodesk to your user PATH, which only takes effect in a new terminal. See Installation.
Problem: The completion script on disk is the one the older version wrote.
Solution: Re-run neetodesk completion <shell>. See Shell completion.
Problem: The CLI acts as the person who signed in, so it is bounded by that person’s role. An agent restricted to their own tickets or to their groups sees a narrowed list.
Solution: Confirm which account you are signed in as with neetodesk whoami. If the account is right, the restriction is the role, not the CLI.

​
Getting the version

Include the version when you report a problem: