Skip to main content
The TextMine CLI is the command-line entry point for developers, operators, and trusted agent runtimes that need repeatable TextMine workflows from a terminal. Use the CLI when you want to run the same TextMine operation from a local shell, CI job, deployment script, support runbook, or automation runtime. Use the web app when a person needs to inspect documents, review model output, approve changes, or work interactively in Workbench, Vault, Workflows, Records, Playbooks, Scribe, or Legislate.

​
What the CLI is for

The CLI should make API-backed work easier without changing TextMine’s permission model. Common uses include:
  • Checking which TextMine environment and account a runtime is configured for.
  • Running safe read-only checks before an integration goes live.
  • Calling Public API V3 operations from scripts.
  • Uploading or polling documents in trusted automation.
  • Starting and inspecting task-agent work.
  • Smoke-testing the hosted TextMine MCP endpoint.
  • Capturing reproducible support diagnostics without exposing secrets.
For exact operation IDs and request shapes, use API and developer docs and the Public API reference. For agent-facing protocol setup, use TextMine MCP server.

​
How it authenticates

The CLI uses the same credentials as Public API V3 and TextMine MCP. It is not a separate access layer. OAuth client registrations can use TextMine’s protected-resource metadata:

​
Environment configuration

Use TextMine-issued environment URLs. For the public UK multitenant deployment, the common values are:
Dedicated or customer-specific deployments should use the URLs supplied by TextMine. Do not guess a tenant URL, and do not mix staging credentials with production URLs.

​
Safety model

CLI commands can represent real users or service accounts. Treat them like API and MCP tools:
  • Read before mutating when current state matters.
  • Ask for human confirmation before creating, deleting, publishing, sending, assigning, or triggering workflow actions.
  • Keep secrets out of terminal history, logs, prompts, tickets, screenshots, commits, and shared documentation.
  • Prefer idempotency keys for retryable create or trigger operations when the API supports them.
  • Include Vault, document, workflow, run, record, or task IDs in audit summaries.
Start with CLI quickstart when setting up a new terminal or automation runtime.
Last modified on July 7, 2026