Getting started with NeetoPlaydash CLI

Imagine your nightly Playwright run failed and you need to know which specs broke, whether a test is flaky, and where to open the trace — without clicking through project after project in the NeetoPlaydash dashboard.

With NeetoPlaydash CLI, you can handle that flow from your terminal. You can list projects, inspect runs, drill into failing specs and tests, review result history, and fetch trace viewer URLs. When you manage multiple workspaces or wire test data into scripts and AI agents, this command-based flow is easier to repeat than manually navigating the same screens every time.

What is NeetoPlaydash CLI?

NeetoPlaydash CLI is the command-line interface for viewing and analyzing Playwright test results in your NeetoPlaydash workspace.

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

Why this is useful

Think of NeetoPlaydash CLI as a command-driven control panel for test results instead of clicking through the web UI.

A few examples of what becomes possible:

• You want a quick health check on last night's run, so you list recent runs and filter by failed status.

• You need to see whether a spec is flaky, so you pull its result history across recent runs.

• You are debugging a failure, so you open trace viewer URLs for the failing test entity.

• You want repeatable ops, so you use JSON or TOON output in scripts or AI-assisted workflows.

• You manage multiple NeetoPlaydash workspaces and can target each one with --subdomain instead of switching accounts in the browser.

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 NeetoPlaydash 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 NeetoPlaydash workspaces.

2. A NeetoPlaydash account with permission to view projects and test runs in those workspaces.

Install NeetoPlaydash CLI

macOS / Linux

Homebrew (recommended on macOS):

brew install neetozone/tap/neetoplaydash

Shell script:

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

Windows

PowerShell (recommended on Windows):

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

Command Prompt (CMD):

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

Verify installation

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

neetoplaydash --help

You should see output similar to:

A command-line interface for NeetoPlaydash.

Usage:
  neetoplaydash [command]

Available Commands:
  commands         List all available commands as JSON
  completion       Generate the autocompletion script for the specified shell
  doctor           Check CLI health and connectivity
  help             Help about any command
  login            Log in to NeetoPlaydash via browser
  logout           Log out and clear saved credentials
  projects         Manage projects
  result-histories View a test entity's result history across runs
  runs             Manage runs
  setup            Set up NeetoPlaydash for AI coding assistants
  test-entities    Manage test entities (specs and tests)
  traces           Get Playwright trace viewer URLs for a run
  version          Print the CLI version
  whoami           Show current authenticated user(s)

Flags:
  -h, --help               help for neetoplaydash
      --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 "neetoplaydash [command] --help" for more information about a command.

Authenticate your workspace

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

To log into NeetoPlaydash CLI, execute the following command:

neetoplaydash login

This prompts you to enter the subdomain for your workspace. If your workspace is acme.neetoplaydash.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.neetoplaydash.com

Global flags

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

• --subdomain <name>: choose which logged-in workspace to target.
  Required only when you have more than one workspace logged in.

• --json: force JSON envelope output

• --quiet: output raw payload only

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

Output formats

By default, commands use pretty 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 NeetoPlaydash CLI guidance to that assistant environment.

Running these commands gives your agent context on how to use NeetoPlaydash 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:

neetoplaydash setup claude    # Register plugin with Claude Code
neetoplaydash setup cursor    # Write rules for Cursor IDE
neetoplaydash setup windsurf  # Write rules for Windsurf IDE
neetoplaydash setup copilot   # Add instructions for GitHub Copilot
neetoplaydash setup gemini    # Add instructions for Gemini CLI
neetoplaydash setup codex     # Add instructions for OpenAI 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 NeetoPlaydash workspace, NeetoPlaydash CLI helps you manage them much more easily.

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

neetoplaydash 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:

neetoplaydash projects list --subdomain acme
neetoplaydash projects list --subdomain globex

If you skip --subdomain in multi-workspace mode, the CLI returns an error and asks you to specify one.

Troubleshooting with doctor

If something does not work as expected, run:

neetoplaydash doctor

This checks:

• Whether you are authenticated

• Whether the workspace API endpoint is reachable

• Which CLI version is running

Additional resources

• NeetoPlaydash MCP server — Integrate NeetoPlaydash with AI assistants