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.2.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.2-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: orchagent_cli-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 a070d620bf04f24a8e7c6317d511712f2ebce330693b0625c35a159f827f9dc8
MD5 7fa8d963d5eedf266ae3403ceb044475
BLAKE2b-256 d83463b15df375923ec6da76c9cfb99f361d1f15ffa5fade9348d15b5a61f9ee

See more details on using hashes here.

File details

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

File metadata

  • Download URL: orchagent_cli-0.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 15e24fcb6350a553d70ef86a5e70ece291947ab9716593efaa404945c29795ac
MD5 c0b88069a84ae1f01f51a9f83f58339d
BLAKE2b-256 6329862d96183a01a61f9161a4a40729cd39edd5cad830b01e01862d84473e43

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