Getting started with NeetoForm CLI

Imagine reviewing form activity at the end of the day and getting the answers you need without jumping between pages: your forms, submission counts, and who’s on your team, all from one place.

With NeetoForm CLI, you can do that from your terminal. You can list forms, inspect form submissions, review team members, and run health checks. When you repeat the same operational steps often, this command-based flow is easier to reuse.

What is NeetoForm CLI?

NeetoForm CLI is the command-line interface for managing forms, submissions, and workspace team members in your NeetoForm 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 NeetoForm 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 forms in your workspace, so you run one command instead of opening each workspace page.

• You need to inspect submissions for a specific form ID, so you query them directly from terminal output.

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

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

• You want to run the same checks repeatedly as part of operations without redoing manual navigation.

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

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

Install NeetoForm CLI

macOS / Linux

Homebrew (recommended on macOS):

brew install neetozone/tap/neetoform

Shell script:

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

Windows

PowerShell (recommended on Windows):

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

Command Prompt (CMD):

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

Verify installation

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

neetoform --help

You should see output similar to:

A command-line interface for NeetoForm.

Usage:
  neetoform [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
  forms        Manage forms
  help         Help about any command
  login        Log in to NeetoForm via browser
  logout       Log out and clear saved credentials
  setup        Set up NeetoForm 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 neetoform
      --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 "neetoform [command] --help" for more information about a command.

Authenticate your workspace

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

To log into NeetoForm CLI, execute the following command:

neetoform login

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

• Standard output (default): command-dependent, often JSON envelope for list/read commands in current behavior.

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

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

neetoform setup claude    # Creates a skill for Claude Code
neetoform setup cursor    # Creates rules for Cursor
neetoform setup windsurf  # Creates rules for Windsurf
neetoform setup copilot   # Adds instructions for GitHub Copilot
neetoform setup gemini    # Adds instructions for Gemini CLI
neetoform 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 NeetoForm 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:

neetoform forms list --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.

Troubleshooting with doctor

If something does not work as expected, run:

neetoauth doctor

This checks:

• Whether you are authenticated

• Whether the workspace API endpoint is reachable

• Which CLI version is running

Additional resources

• NeetoForm MCP server - Integrate NeetoForm with AI assistants.