How can we help?

Getting started with NeetoRecord CLI

Imagine wrapping up a week of screen recordings and needing answers fast: which recordings got views, where they live in folders, who has workspace access, and whether transcripts are ready — without opening each page in the NeetoRecord UI.

With NeetoRecord CLI, you can do that from your terminal. You can list and search recordings, inspect transcripts and chapters, manage folders and tags, review team members, check workspace analytics, and run health checks. When you repeat the same operational steps often, this command-based flow is easier to reuse.

What is NeetoRecord CLI?

NeetoRecord CLI is the command-line interface for managing screen recordings, folders, tags, team members, and workspace analytics in your NeetoRecord 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 NeetoRecord 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 recordings in your workspace, so you run one command instead of paging through the Recordings library.

  • You need to find a recording by spoken content, so you search transcripts directly from terminal output.

  • You want to organize recordings into folders or review tags with repeatable commands.

  • You need share links, embed codes, or download URLs for a recording without copying from the UI.

  • You want output in JSON or TOON format for scripts and AI workflows.

  • You want to run the same checks across multiple workspaces you manage without redoing manual navigation in each one.

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

  2. Permission to view recordings and manage team members in those workspaces.

Install NeetoRecord CLI

macOS / Linux

brew install neetozone/tap/neetorecord

Shell script:

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

Windows

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

Command Prompt (CMD):

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

Verify installation

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

neetorecord --help

You should see output similar to:

A command-line interface for NeetoRecord.

Usage:
  neetorecord [command]

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

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

Authenticate your workspace

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

To log into NeetoRecord CLI, execute the following command:

neetorecord login

This prompts you to enter the subdomain for your workspace. If your workspace is acme.neetorecord.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.neetorecord.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 message-style actions)

  • --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

Command

Description

login

Log in to NeetoRecord via browser

logout

Log out and clear saved credentials

whoami

Show current authenticated user(s)

Workspace commands

Command

Description

recordings

Manage recordings. Detailed reference is available here.

folders

Manage recording folders. Detailed reference is available here.

team-members

Manage workspace team members. Detailed reference is available here.

analytics

View organization analytics. Detailed reference is available here.

tags

List recording tags. Detailed reference is available here.

Utility commands

Command

Description

doctor

Check CLI health and connectivity

version

Print the CLI version

commands

List all available commands as JSON

setup

Set up NeetoRecord for AI coding assistants

AI assistant setup commands

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

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

neetorecord setup claude    # Register plugin with Claude Code
neetorecord setup cursor    # Write NeetoRecord rules for Cursor IDE
neetorecord setup windsurf  # Write NeetoRecord rules for Windsurf IDE
neetorecord setup copilot   # Add NeetoRecord instructions for GitHub Copilot
neetorecord setup gemini    # Add NeetoRecord instructions for Gemini CLI
neetorecord setup codex     # Add NeetoRecord 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 NeetoRecord 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:

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

neetorecord recordings list --subdomain globex
neetorecord recordings list --subdomain acme

Troubleshooting with doctor

If something does not work as expected, run:

neetorecord doctor

This checks:

  • Whether you are authenticated

  • Whether the workspace API endpoint is reachable

  • Which CLI version is running

Additional resources