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

> Authentication, diagnostics, versioning, upgrades, AI-assistant setup, and shell completion.

These commands manage the CLI itself rather than a NeetoDesk resource.

## Authentication

### login

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

Opens your browser to sign in and saves credentials for the workspace. Omit `--subdomain` to be prompted.

```text Sample output theme={"system"}
Authenticated as oliver@example.com on acme.neetodesk.com.
```

### logout

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

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

```text Sample output theme={"system"}
Signed out of acme.neetodesk.com.
```

### whoami

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

Lists each signed-in account and marks it `(default)` when only one is signed in. Pass `--subdomain <name>` to show one workspace.

```text Sample output theme={"system"}
Authenticated as oliver@example.com on acme.neetodesk.com (default).
```

## Diagnostics

### doctor

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

Checks authentication, API reachability, and the CLI version. See [Troubleshooting](/cli/troubleshooting). When several workspaces are signed in, pass `--subdomain <name>`.

```text Sample output theme={"system"}
✓ Authentication: authenticated as oliver@example.com on acme.neetodesk.com
✓ API connection: https://acme.neetodesk.com (responding in 214ms)
✓ CLI version: 1.4.0
```

### version

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

Prints the CLI version, commit hash, and build date.

```text Sample output theme={"system"}
neetodesk 1.4.0 (commit: a1b2c3d, built: 2026-07-01)
```

### commands

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

Prints the complete command and flag catalog for the installed version as JSON. It is useful in scripts and with AI assistants.

```json Sample output theme={"system"}
[
  {
    "command": "neetodesk tickets",
    "description": "Manage tickets",
    "subcommands": [
      {
        "command": "neetodesk tickets list",
        "description": "List tickets",
        "flags": [
          { "name": "status", "type": "string", "description": "Filter by status (comma-separated, e.g. open,pending)" }
        ]
      }
    ]
  }
]
```

## Upgrade

### update

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

Updates the CLI to the latest release using the method that installed it. When the binary lives in a Homebrew Cellar it runs `brew update && brew upgrade neetozone/tap/neetodesk`; on other macOS and Linux installs it downloads the shell installer to a temporary file and runs it; on Windows it runs the PowerShell installer. The installers are the same ones the [Installation](/cli/installation) page uses, fetched over HTTPS. The command prints the detected method and the command it runs, and exits non-zero if that command fails.

```text Sample output theme={"system"}
Detected Homebrew install.
Running: brew update && brew upgrade neetozone/tap/neetodesk
```

After upgrading, re-run `neetodesk completion <shell>` and any `neetodesk setup` command you use so their files match the new version.

## AI-assistant setup

Add NeetoDesk instructions to your AI coding assistant. See [AI assistants](/cli/ai-assistants) for details.

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

```text Sample output theme={"system"}
NeetoDesk plugin extracted to /Users/oliver/.config/neetodesk/claude-plugin

To finish installation, open Claude Code and run these slash commands:
  /plugin marketplace add /Users/oliver/.config/neetodesk/claude-plugin
  /plugin install neetodesk@neetodesk

(Claude Code installs plugins via interactive slash commands - there is no shell equivalent today.)
```

## Shell completion

Shell completion fills in command names, subcommands, and flags when you press `Tab`. It saves you from having to remember the full command tree or look up `--help`.

`neetodesk completion <shell>` installs completion for your shell. For zsh, bash, and PowerShell it writes the script under `~/.config/neetodesk/completions` and adds a marked block to `~/.zshrc`, `~/.bashrc`, or `~/Documents/PowerShell/Microsoft.PowerShell_profile.ps1` that loads it the next time the shell starts. For fish it writes `~/.config/fish/completions/neetodesk.fish`, which fish loads on its own.

<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 (or run `source ~/.zshrc`) to enable it. After upgrading the CLI, run the command again to update the available completions. Re-running it replaces the existing script and configuration without adding duplicates.

<Note>
  To configure it yourself, pass `--print` to write the raw script to standard output instead of installing it:

  ```bash theme={"system"}
  neetodesk completion zsh --print
  ```
</Note>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.