> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.neetodesk.com/llms.txt
> Use this file to discover all available pages before exploring further.

# utility

> Sign in and out, check the CLI's health, install shell completion, and upgrade.

The commands on this page manage the CLI itself rather than a NeetoDesk resource, so none of
them have an API-reference counterpart.

## login

Signs in to a workspace through your browser and saves the session. The CLI prompts for your
subdomain unless you pass one.

```bash theme={"system"}
neetodesk login
neetodesk login --subdomain acme
```

See [Authentication](/cli/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`.

```bash theme={"system"}
neetodesk logout --subdomain acme
neetodesk logout --all
```

| Flag    | Type   | Required | Default | Description                       |
| ------- | ------ | -------- | ------- | --------------------------------- |
| `--all` | `bool` |          | `false` | Sign out of every saved subdomain |

## whoami

Reports which account is signed in, and on which workspace. With several workspaces signed in,
it lists all of them.

```bash theme={"system"}
neetodesk whoami
```

```
Authenticated as oliver.smith@example.com on acme.neetodesk.com (default).
```

## 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.

```bash theme={"system"}
neetodesk doctor
```

```
✓ Authentication: authenticated as oliver.smith@example.com on acme.neetodesk.com
✓ API connection: https://acme.neetodesk.com (responding in 214ms)
✓ CLI version: 1.0.7
```

## version

Prints the CLI version. Include it when reporting a problem.

```bash theme={"system"}
neetodesk version
```

## update

Replaces the binary in place with the latest release. If you installed through Homebrew, run
`brew upgrade neetodesk` instead so the formula stays in step.

```bash theme={"system"}
neetodesk update
```

## setup

Installs NeetoDesk instructions into an AI coding assistant. See
[AI assistants](/cli/ai-assistants) for what each subcommand writes and where.

```bash theme={"system"}
neetodesk setup claude
neetodesk setup cursor
neetodesk setup windsurf
neetodesk setup copilot
neetodesk setup gemini
neetodesk setup codex
```

## commands

Prints the full command catalog as JSON. The command reference on this site is generated from
its output.

```bash theme={"system"}
neetodesk commands
```

## Shell completion

`neetodesk completion <shell>` writes the completion script under
`~/.config/neetodesk/completions` and wires your shell to load it on the next start. There is
nothing to source by hand.

<CodeGroup>
  ```bash zsh theme={"system"}
  neetodesk completion zsh
  ```

  ```bash bash theme={"system"}
  neetodesk completion bash
  ```

  ```bash fish theme={"system"}
  neetodesk completion fish
  ```

  ```powershell powershell theme={"system"}
  neetodesk completion powershell
  ```
</CodeGroup>

Start a new shell afterwards so the completion script is loaded. Re-running the command
refreshes both the script and the shell configuration.

<Note>
  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.
</Note>

To inspect the script rather than install it, pass `--print` and it goes to standard output
instead:

```bash theme={"system"}
neetodesk completion zsh --print
```