Bigmind CLI Overview

The Bigmind CLI lets you read and manage supported Bigmind data from a terminal. It is installed by the Bigmind Mac app and uses the same signed-in user, tenant, and permission policies as the app.

Access note: Ask your account manager for access to the Bigmind Mac app. The Mac app provides the authenticated bigmind command line tool.

#Install the CLI

1. Install and open the Bigmind Mac app.
2. Sign in to the workspace you want to use.
3. Open the app status window or tray menu and choose Install Command Line Tool.
4. Open a new terminal and run bigmind whoami.

bigmind whoami

bigmind whoami

A healthy installation prints the user and tenant context used by CLI calls:

user_id=usr_...
tenant_type=organization
tenant_id=org_...

user_id=usr_...
tenant_type=organization
tenant_id=org_...

#Authentication and access control

You do not pass an API key to the CLI. Commands are authenticated through Bigmind Desktop's channel key. The server infers the acting user and tenant from that token, then applies the same access checks and permission policies used by the Bigmind app.

#Output format

Most commands return formatted JSON:

{
  "success": true,
  "data": {
    "...": "..."
  }
}

{
  "success": true,
  "data": {
    "...": "..."
  }
}

Use tools such as jq to extract fields in scripts.

#Passing JSON

Commands that accept a request body use --json for inline JSON or --json-file for larger payloads.

bigmind api lists create --json '{"name":"Account review queue"}'
bigmind api lists rows tbl_123 add --json-file payloads/add-rows.json

bigmind api lists create --json '{"name":"Account review queue"}'
bigmind api lists rows tbl_123 add --json-file payloads/add-rows.json

#Passing query parameters

Use repeated --query key=value arguments for query parameters.

bigmind api crm accounts list --query limit=25
bigmind api lists columns tbl_123 values col_status --query limit=10 --query offset=0

bigmind api crm accounts list --query limit=25
bigmind api lists columns tbl_123 values col_status --query limit=10 --query offset=0

#Available customer CLI areas