> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.neetoengage.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 NeetoEngage resource.

## Authentication

### login

```bash theme={"system"}
neetoengage 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.neetoengage.com.
```

### logout

```bash theme={"system"}
neetoengage logout --subdomain your-workspace
neetoengage 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.neetoengage.com.
```

### whoami

```bash theme={"system"}
neetoengage 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.neetoengage.com (default).
```

## Diagnostics

### doctor

```bash theme={"system"}
neetoengage 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.neetoengage.com
✓ API connection: https://acme.neetoengage.com (responding in 214ms)
✓ CLI version: 1.0.2
```

### version

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

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

```text Sample output theme={"system"}
neetoengage 1.0.2 (commit: a1b2c3d, built: 2026-09-01)
```

### commands

```bash theme={"system"}
neetoengage 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": "neetoengage tracks",
    "description": "Show the columns of the feature request board",
    "subcommands": [
      {
        "command": "neetoengage tracks list",
        "description": "List tracks, the columns of the feature request board"
      }
    ]
  }
]
```

## Upgrade

### update

```bash theme={"system"}
neetoengage 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/neetoengage`; 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/neetoengage
```

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

## AI-assistant setup

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

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

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

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

(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`.

`neetoengage completion <shell>` installs completion for your shell. For zsh, bash, and PowerShell it writes the script under `~/.config/neetoengage/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/neetoengage.fish`, which fish loads on its own.

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

  ```bash Bash theme={"system"}
  neetoengage completion bash
  ```

  ```bash Fish theme={"system"}
  neetoengage completion fish
  ```

  ```powershell PowerShell theme={"system"}
  neetoengage 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"}
  neetoengage completion zsh --print
  ```
</Note>


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