Use the CLI in terminals and scripts

npm install --global @datamini/asktable-cli

After installation, the asktable command is available; asktable --help lists all command groups.

Interactive login asks for the API Key and Server URL in sequence:

asktable auth login

For noninteractive use, pass the global options directly:

asktable auth login --api-key YOUR_API_KEY --server https://<your-AskTable-site>

After successful login, configuration is written to the current user's ~/.config/asktable/config.json with keys api_key and api_url. Use asktable auth status to view the active Key (only its first 5 characters plus ***) and Server; asktable auth logout clears local configuration.

Inject the Key through environment variables instead of writing it to a file:

export ASKTABLE_API_KEY='YOUR_API_KEY'
export ASKTABLE_API_URL='https://<your-AskTable-site>'

Priority from highest to lowest is: command-line --api-key / --server → environment variables ASKTABLE_API_KEY / ASKTABLE_API_URL → configuration file → built-in default https://api.asktable.com. Private deployments must explicitly specify Server, or requests go to Cloud.

query is the only entry point for questions. Without a specified conversation, it creates a conversation, sends a message, polls until analysis finishes, and outputs the answer and conversation_id:

asktable query "Your data question" \
  --data-agent <agent_id> \
  --json

Use either --data-agent or --datasources; --datasources accepts multiple comma-separated data source IDs:

asktable query "Your data question" --datasources ds_xxxxxxxx --json

Polling runs every 1 second, waiting up to 120 seconds; a timeout reports Conversation <id> response timed out (120s).

Pass the previous output's conversation_id to follow up in the same conversation:

asktable query "Your follow-up question" \
  --conversation <conversation_id> \
  --json

For row-level permissions, pass a role and role variables; variable options can be repeated:

asktable query "Your data question" \
  --data-agent <agent_id> \
  --role <role_id> \
  --role-variable dept_id=D001 \
  --json

Common command groups:

Delete commands ask for confirmation by default; --yes skips it. Refer to asktable --help and each subcommand's --help for full options.

asktable get-skill prints an instruction file teaching an AI coding assistant to use asktable:

asktable get-skill

Save the output as a Markdown file in the coding assistant's skill directory to drive these commands with natural language. “Skill” here means CLI instructions for the coding assistant, distinct from an Agent's Skills, which describe analysis methods.

The same guidance is available on the web: the top of “Settings” → “API-Key” has a collapsible “Use in AI Agent” section containing this instruction, ready to copy and send to an Agent.