Getting started with NeetoKB CLI

Imagine publishing a help article, checking who can edit your knowledge base, or searching existing content without opening NeetoKB. You want to confirm category placement, review team access, and run a quick health check — all without clicking through multiple screens.

With NeetoKB CLI, you can handle that flow from one place: your terminal. You can create and update articles, list categories and authors, search content, manage team members, and inspect workspace settings. When you manage multiple workspaces or repeat the same operational steps often, this command-based flow is easier to reuse than manually going through the same screens every time.

What is NeetoKB CLI?

NeetoKB CLI is the command-line interface for managing your NeetoKB workspace — help articles, categories, authors, search, recommendations, settings, and team members.

Authentication happens through a browser login flow. After login, the CLI stores your session credentials locally in ~/.config/neetokb/auth.json and uses them for subsequent commands.

Why this is useful

Think of NeetoKB CLI as a command-driven control panel for your knowledge base instead of clicking through multiple admin screens.

A few examples of what becomes possible:

• You need to publish or update a help article from a script or your editor workflow, so you create or update it in one command.

• You want to audit content before a release, so you list or search articles directly from terminal output.

• You need to onboard an editor, so you invite them and verify their role without leaving the terminal.

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

• You manage multiple NeetoKB workspaces, so you target each one with --subdomain instead of switching browser sessions.

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

2. Permission to manage articles and/or team members in those workspaces.

Install NeetoKB CLI

macOS / Linux

Homebrew (recommended on macOS):

brew install neetozone/tap/neetokb

Shell script:

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

Windows

PowerShell (recommended on Windows):

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

Command Prompt (CMD):

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

Verify installation

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

neetokb --help

You should see output similar to:

A command-line interface for NeetoKB.

Usage:
  neetokb [command]

Available Commands:
  articles        Manage articles
  authors         List article authors
  categories      Manage categories
  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 NeetoKB via browser
  logout          Log out and clear saved credentials
  recommendations Manage recommendations
  search          Search articles
  settings        Manage workspace settings
  setup           Set up NeetoKB for AI coding assistants
  team-members    Manage team members
  version         Print the CLI version
  whoami          Show current authenticated user(s)

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

Authenticate your workspace

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

To log into NeetoKB CLI, execute the following command:

neetokb login

This prompts you to enter the subdomain for your workspace. If your workspace is acme.neetokb.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.neetokb.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 pretty terminal output on a TTY.

You can switch output format explicitly using flags:

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

• JSON envelope (--json): includes data and optional breadcrumbs / pagination

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

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

Flag precedence when multiple are set: --toon > --quiet > --json > pretty.

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 NeetoKB CLI guidance to that assistant environment.

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

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

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

neetokb articles list --subdomain acme
neetokb articles list --subdomain globex

Troubleshooting with doctor

If something does not work as expected, run:

neetokb doctor --subdomain your-subdomain

This checks:

• Whether you are authenticated

• Whether the workspace API endpoint is reachable

• Which CLI version is running

Additional resources

• NeetoKB MCP server - Integrate NeetoKB with AI assistants