Threadify CLI

Install

Download and verify a CLI release and put threadify-cli on your PATH. Install it separately from the Engine.

threadify-cli config set api-url https://threadify.example.com
threadify-cli login
threadify-cli whoami

Or select the Engine during login:

threadify-cli login --api-url https://threadify.example.com
# On a remote terminal, print the approval URL without opening a browser:
threadify-cli login --api-url https://threadify.example.com --no-browser

Sign in to the Engine and select Approve CLI login. Missing URLs are prompted. Use --no-browser remotely; --no-input or CI=true disables prompts. Approval links last five minutes; credentials last 30 days. Role changes, suspension, or source-key revocation invalidate logins. Set the Engine’s registry.browser_origin to its public UI origin.

threadify-cli logout                # Revoke the saved managed CLI login
threadify-cli config get api-url
threadify-cli config show           # Key redacted

logout revokes the managed CLI credential. It does not revoke manually configured keys or unset THREADIFY_API_KEY.

Automation and configuration

For scripts and service accounts, configure the URL and supply an API key:

threadify-cli config set api-url https://threadify.example.com
export THREADIFY_API_KEY='<personal-or-service-account-key>'
threadify-cli contracts list

To save a key without putting it in command arguments, pipe it on stdin:

printf '%s' "$THREADIFY_API_KEY" | threadify-cli config set --api-key-stdin

Stdin avoids putting the key in shell arguments. Config lives at $HOME/.config/threadify/cli.yaml; override with THREADIFY_CLI_CONFIG. Changing the saved Engine URL clears its credential. URL precedence is --api-url, THREADIFY_API_URL, THREADIFY_ENGINE_URL, then saved config. Credential precedence is --key, the saved credential for that Engine, then THREADIFY_API_KEY. Commands print JSON to stdout, errors to stderr and exit nonzero on failure. Writes are not retried automatically; check state before retrying a timed-out write. Use --timeout 30s to change the timeout and --file - to read stdin.

Trace ingestion rules

threadify-cli ingestion-rules get > rules.json
# Edit filters, keeping the revision; use [] to disable.
threadify-cli ingestion-rules set --file rules.json
threadify-cli ingestion-rules preview --file preview.yaml

Admin access is required to save. Rules apply to /v1/traces, not SDK events. See filtering for the preview format and scope.

Contracts

threadify-cli contracts preview --file contract.feature
threadify-cli contracts create --file contract.feature
threadify-cli contracts list --search checkout --limit 25 --offset 0
threadify-cli contracts get --id CONTRACT_ID
threadify-cli contracts update --id CONTRACT_ID --file contract-v2.feature
threadify-cli contracts versions --id CONTRACT_ID
threadify-cli contracts get --id CONTRACT_ID --version 1
threadify-cli contracts delete --id CONTRACT_ID --yes

Contracts use Gherkin (.feature) source. Updates create a new version; deletion requires --yes.

Entity profile types and profiles

Choose a reference key for the entity. Save as customers.yaml:

name: Customers
type: [customer_id]
description: Customer workflows

threadify-cli profile-types create --file customers.yaml
threadify-cli profile-types list
threadify-cli profiles create --type-id TYPE_ID --ref-value CUST-001 --name 'Jane Doe'
threadify-cli profiles list --type Customers
threadify-cli profiles get --type Customers --ref-value CUST-001
threadify-cli profiles get --id PROFILE_ID
threadify-cli profiles history --id PROFILE_ID

Use the returned type ID. Threads with matching customer_id refs populate the profile after archival. Profiles can be created before activity; repeating the same type and ref updates the name. Configure metrics under Entity Profiles.

Threads and references

threadify-cli threads resolve --thread-key order:ORD-1001 --label 'Order ORD-1001' --contract checkout --role worker \
  --refs '{"order_id":"ORD-1001","customer_id":"CUST-001"}' --tags '["checkout"]'
# Later requests resume the pinned contract using only the application key.
threadify-cli threads resolve --thread-key order:ORD-1001
threadify-cli threads get --id THREAD_ID
threadify-cli threads list --status active --limit 25 --offset 0
threadify-cli threads find --ref-key order_id --ref-value ORD-1001
threadify-cli threads add-refs --id THREAD_ID --refs '{"ticket_id":"T-123"}'
threadify-cli threads close --id THREAD_ID --status completed
threadify-cli threads verify --id THREAD_ID

--contract and --role are optional for contract-free threads. Finding by ref returns every matching thread; refs are not unique thread identifiers. close requires an explicit completed or cancelled status. verify prints integrity results and exits nonzero when verification fails. Use SDKs or OTEL for event instrumentation; the CLI manages and inspects resources. For other Engine queries:

threadify-cli graphql --file query.graphql --variables '{"id":"THREAD_ID"}'
threadify-cli help

Coding-agent skills

Install the bundled contract and investigation instructions for your coding agent:

threadify-cli skills install --agent codex
threadify-cli skills install --agent all

Supported targets are codex, claude, cursor, and copilot. User scope is the default; add --project for the current repository. Existing modified skills are preserved unless --force is specified. Installation does not supply credentials or start the Engine. Contract validation itself remains deterministic.

Getting Started

Core Concepts

Integrity and access

API Reference

Install

Automation and configuration

Trace ingestion rules

Contracts

Entity profile types and profiles

Threads and references

Coding-agent skills

​Install

​Connect and sign in

​Automation and configuration

​Trace ingestion rules

​Contracts

​Entity profile types and profiles

​Threads and references

​Coding-agent skills

Install

Connect and sign in

Automation and configuration

Trace ingestion rules

Contracts

Entity profile types and profiles

Threads and references

Coding-agent skills