Skip to main content

CLI for the Orchagent API

Project description

orchagent-cli

CLI for the Orchagent API, built on the orchagent Python SDK.

Dev Install

# 1) Install SDK first (from the sibling repo)
cd /home/admin/Downloads/git/orchagent-python
python -m venv .venv && source .venv/bin/activate
pip install -U pip wheel
pip install -e .

# 2) Install CLI
cd /home/admin/Downloads/git/orchagent-cli
pip install -e .

# 3) Use
orch --help

Examples

# Configure base URL via env (or pass --base-url to each command)
export ORCHAGENT_BASE_URL=http://localhost:8080

# Auth
orch auth register --email you@example.com --password pass123
orch auth login --email you@example.com --password pass123

# Create thread from a workflow JSON
THREAD=$(orch threads create --spec ../Orchagent/example_workflows/composio_calendar_hil_chat.json -q)
echo "Thread: $THREAD"

# Send a message and stream events
RUN=$(orch runs send $THREAD --prompt "Hi" --secrets-file secrets.json -q)
orch runs stream $RUN

# Interactive chat
orch chat start --spec ../Orchagent/example_workflows/composio_calendar_hil_chat.json

Install

Recommended (isolated):

pipx install orchagent-cli
orch --help

Or with pip (in a venv):

python -m venv .venv && source .venv/bin/activate
pip install orchagent-cli
orch --help

Secrets and Inputs Files

  • --secrets-file secrets.json: Pass provider credentials and other secrets at run-time. The CLI wraps this under body.secrets automatically.
  • --inputs-file inputs.json: Pass non-secret inputs (e.g., user_id, event payloads).

Secrets precedence on the server: run > thread > workflow > environment.

Common secrets.json examples:

  • OpenAI:
{"providers": {"openai": {"api_key": "sk-..."}}}
  • OpenAI-compatible (custom base_url):
{"providers": {"openai": {"api_key": "sk-...", "base_url": "https://compatible.example/api"}}}
  • Anthropic:
{"providers": {"anthropic": {"api_key": "sk-ant-..."}}}
  • Gemini (Google GenAI):
{"providers": {"google_genai": {"api_key": "AIza..."}}}
  • Ollama (local):
{"providers": {"ollama": {"base_url": "http://localhost:11434"}}}
  • Tavily key:
{"TAVILY_API_KEY": "tvly-...", "providers": {"openai": {"api_key": "sk-..."}}}

Security: do not commit secrets.json; consider chmod 600 secrets.json.

Commands Summary

  • orch auth register --email ... --password ...
  • orch auth login --email ... --password ...
  • orch auth whoami | logout
  • orch threads create --spec path.json [-q]
  • orch threads secrets <thread_id> --secrets-file file.json
  • orch threads history <thread_id> [--limit 20]
  • orch runs send <thread_id> --prompt "..." [--inputs-file file.json] [--secrets-file file.json] [-q]
  • orch runs stream <run_id>
  • orch runs resume <run_id>
  • orch approvals approve <run_id> --tool NAME [--args-keys k1,k2]
  • orch approvals clear [--all] [--user EMAIL]
  • orch chat start [--spec path.json | --thread-id th_x]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

orchagent_cli-0.1.3.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

orchagent_cli-0.1.3-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file orchagent_cli-0.1.3.tar.gz.

File metadata

  • Download URL: orchagent_cli-0.1.3.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for orchagent_cli-0.1.3.tar.gz
Algorithm Hash digest
SHA256 e3ec70f2aeb81ec98ee9561c4ac3f6038fd3a2c925f4e34c46992099eadf8f57
MD5 3fe0cc3c1c573c5beb7ec8461198f03b
BLAKE2b-256 bca53b0f126920168aa5020b8ae79ede4500e82ed40caed9ef45bd6cae38a8b3

See more details on using hashes here.

File details

Details for the file orchagent_cli-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: orchagent_cli-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 5.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for orchagent_cli-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5ba3eed9ab5e5ddfda3caaf75e767d0a915b4f4f401892687b2652b0d7e3510a
MD5 6d21cbc2052c05b347299ac386249e80
BLAKE2b-256 4764a9a9255f319c44f43f7ca9abadec26abe0d716d818d074e667d2f03c391b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page