Incogniton CLI

The Incogniton CLI (incogniton-cli) lets you drive Incogniton straight from your terminal — no SDK or code required. Every endpoint of the local automation API is available as a command: list and inspect profiles, launch and stop browsers, manage cookies, and start Puppeteer or Selenium sessions, all from a shell.

The CLI talks to the Incogniton app running on your own machine (127.0.0.1, default port 35000), just like the SDKs and the REST API. Output is human-readable in the terminal and automatically switches to raw JSON when piped, so commands compose naturally into scripts and pipelines.

Installation

The CLI is installed and kept up to date by the Incogniton app itself — there is nothing to download manually.

1. 1

   Install from the app

   In the Incogniton app, go to Settings → Automation and click Download CLI. The app downloads the right binary for your platform, verifies it, and adds its folder to your PATH so you can run it from any terminal.

2. 2

   Open a new terminal

   The PATH change only applies to terminals opened after installation, so open a fresh terminal window.

3. 3

   Verify it works

   With the Incogniton app running, check that the CLI can reach it:

   Terminal

   incogniton-cli alive
   # OK
   

   CopyCopied!

While installed, the CLI updates automatically whenever the Incogniton app starts — you never need to update it yourself. To remove it (including the PATH entry), use Uninstall CLI in the same Settings → Automation tab.

The binary itself lives in a cli folder inside Incogniton's data directory:

Usage

Commands are named after the API endpoints they call, and endpoint parameters become flags with the same name:

incogniton-cli profile-get-all                  # list all profiles (table)
incogniton-cli profile-get --id <profile-id>    # one profile (detail view)
incogniton-cli profile-launch --id <profile-id> # launch a profile's browser
incogniton-cli profile-stop --id <profile-id>   # stop it again

Run incogniton-cli --help for the full command list, or incogniton-cli <command> --help for a command's flags.

Two global flags work on every command:

Scripting and Pipelines

In an interactive terminal the CLI prints formatted tables and detail views. As soon as output is piped or redirected, it switches to JSON automatically — no --json needed. For responses that wrap their data, the CLI emits the data itself (the profile document or list) rather than the status envelope, so output feeds directly into tools like jq or straight back into other CLI commands:

# All profile ids, one per line
incogniton-cli profile-get-all | jq -r '.[].general_profile_information.browser_id'

# Clone a profile: fetch its document and add it back (the server assigns a new id)
incogniton-cli profile-get --id <profile-id> | incogniton-cli profile-add

A failed request prints the server's error message and exits with a non-zero status code, so shell scripts can detect failures the usual way (if, &&, set -e).

Sending Profile Documents

profile-add and profile-update send a full profile JSON document, which they accept in three ways:

incogniton-cli profile-add --data @profile.json    # from a file
incogniton-cli profile-add --data '{"general_profile_information":{...}}'  # inline
cat profile.json | incogniton-cli profile-add      # from stdin

See the API reference for the profile document structure.

Command Reference

Every command maps one-to-one to an endpoint of the local automation API, with the same parameters, responses, and error shapes. The API reference documents them all — each endpoint includes a ready-to-run example on its CLI tab, alongside the cURL and SDK versions. You can also run incogniton-cli --help for the full command list at any time.

Next Steps

Need help? Join our community or contact support.