Getting started with NeetoDesk CLI

Imagine triaging support tickets at the end of the day and getting the answers you need without jumping between pages: your tickets, customers, team members, and reports, all from one place.

With NeetoDesk CLI, you can do that from your terminal. You can list and update tickets, manage customers, review team members, pull reports, and run health checks. When you repeat the same operational steps often, this command-based flow is easier to reuse.

What is NeetoDesk CLI?

NeetoDesk CLI is the command-line interface for managing tickets, customers, team members, contact forms, and reports in your NeetoDesk workspace.

Authentication happens through a browser login flow. After login, the CLI stores session credentials locally and uses them for subsequent commands.

Why this is useful

Think of NeetoDesk CLI as handling repeatable workspace operations from one command-driven control panel instead of switching across multiple screens.

A few examples of what becomes possible:

• You want a quick list of open tickets, so you run one command instead of opening each view in the UI.

• You need to create or update a ticket from a script, so you use CLI commands with structured output.

• You want to review or manage workspace members with repeatable commands.

• You want report snapshots for a date range without navigating the Reports section.

• You want to do the same set of actions across multiple workspaces you manage, and you can do it with the CLI instead of manually going through the same screens in each workspace.

You do not need to be deeply technical to benefit from this. If you already use simple terminal commands, you will be able to get started with NeetoDesk CLI much more easily, since the commands follow the same patterns you use every day.

What you need to get started

1. Access to one or more NeetoDesk workspaces.

2. Permission to manage tickets, customers, and team members in those workspaces.

Install NeetoDesk CLI

macOS / Linux

Homebrew (recommended on macOS):

brew install neetozone/tap/neetodesk

Shell script:

curl -fsSL https://neetodesk.com/cli/install.sh | sh

Windows

PowerShell (recommended on Windows):

irm https://neetodesk.com/cli/install.ps1 | iex

Command Prompt (CMD):

curl -fsSL https://neetodesk.com/cli/install.cmd -o install.cmd && install.cmd

Verify installation

To verify that you have properly installed NeetoDesk CLI, execute the following command:

neetodesk --help

You should see output similar to:

A command-line interface for NeetoDesk.

Usage:
  neetodesk [command]

Available Commands:
  commands     List all available commands as JSON
  completion   Generate the autocompletion script for the specified shell
  customers    Manage customers
  doctor       Check CLI health and connectivity
  forms        List contact forms
  help         Help about any command
  login        Log in to NeetoDesk via browser
  logout       Log out and clear saved credentials
  reports      View NeetoDesk reports
  setup        Set up NeetoDesk for AI coding assistants
  team-members Manage team members (agents)
  tickets      Manage tickets
  version      Print the CLI version
  whoami       Show current authenticated user(s)

Flags:
  -h, --help               help for neetodesk
      --json               Output as JSON
      --quiet              Output raw data only (no envelope)
      --subdomain string   Override saved subdomain
      --toon               Output in TOON format (token-optimized for AI agents)

Use "neetodesk [command] --help" for more information about a command.

Authenticate your workspace

To get started with NeetoDesk CLI, you first need to authenticate yourself and your workspace. NeetoDesk CLI authenticates with a browser-based login flow and stores credentials locally.

To log into NeetoDesk CLI, execute the following command:

neetodesk login

This prompts you to enter the subdomain for your workspace. If your workspace is acme.neetodesk.com, then enter acme in the prompt.

The command opens a browser window to complete login. After authentication, you should see a success message similar to:

Waiting for authentication.. done!
Logged in as [email protected] on acme.neetodesk.com

Global flags

Every command accepts these persistent flags. All of them are optional:

• --subdomain <name>: choose which logged-in workspace to target.
  Required when multiple workspaces are logged in.

• --json: force JSON envelope output.

• --quiet: output raw payload only (or success for some message-style actions).

• --toon: output TOON format (token-optimized output for AI workflows).

Output formats

By default, commands use standard terminal output.

You can switch output format explicitly using flags:

• Pretty output (default): table or key-value output with breadcrumbs

• JSON envelope (--json): includes data and optional metadata.

• Quiet mode (--quiet): raw payload only.

• TOON mode (--toon): compact token-optimized format.

For paginated list responses, metadata includes:

• current_page_number

• total_pages

• total_records

Commands quick reference

Authentication commands

Workspace commands

Utility commands

AI assistant setup commands

If you use an AI coding assistant, these setup commands add NeetoDesk CLI guidance to that assistant environment.

Running these commands gives your agent context on how to use NeetoDesk CLI commands, and which output modes to use for each command to keep tool usage token-efficient.

Run the command for the tool you use:

neetodesk setup claude    # Register plugin with Claude Code
neetodesk setup cursor    # Creates rules for Cursor
neetodesk setup windsurf  # Creates rules for Windsurf
neetodesk setup copilot   # Adds instructions for GitHub Copilot
neetodesk setup gemini    # Adds instructions for Gemini CLI
neetodesk setup codex     # Adds instructions for Codex

You only need to run one (or the ones you actively use). This saves you from manually copying integration instructions into each assistant.

Dealing with multiple workspaces

If you manage more than one NeetoDesk workspace, pass --subdomain to target the workspace explicitly.

You can log into multiple subdomains. If you have already logged into one subdomain, you can log into another by running:

neetodesk login --subdomain globex

When more than one workspace is configured in your CLI, passing --subdomain in commands is mandatory. This ensures commands run against the correct workspace. If you skip it, the CLI returns an error and asks you to specify a subdomain.

Example:

neetodesk tickets list --subdomain acme
neetodesk tickets list --subdomain globex

Troubleshooting with doctor

If something does not work as expected, run:

neetodesk doctor

This checks:

• Whether you are authenticated

• Whether the workspace API endpoint is reachable

• Which CLI version is running

Additional resources

• NeetoDesk MCP server - Integrate NeetoDesk with AI assistants.