deepflow-openagent-cli

Python command-line client for the OpenAgent OpenAPI: agents, conversations, SSE chat, tools, channels, documents, and knowledge bases.

Install

pip install deepflow-openagent-cli

Usage

export OPENAGENT_HOST="https://your-api-host"
export OPENAGENT_API_KEY="sk-..."
deepflow_openagent_cli docs list
deepflow_openagent_cli agents list

Equivalent module invocation:

python -m deepflow_openagent_cli docs list

Configure API host and key

Legacy NEWAGENT_HOST and NEWAGENT_API_KEY are still read as fallbacks.

When using flags, put global flags before the command:

deepflow_openagent_cli --host http://localhost:5001 --api-key sk-... agents list

Common commands

deepflow_openagent_cli docs show chat.stream --json
deepflow_openagent_cli knowledge list --page 1 --per-page 10
deepflow_openagent_cli knowledge documents 1
deepflow_openagent_cli knowledge query-document 6670 --slice-id 512208 --line 1720

# Knowledge-base file library (requires config scope)
deepflow_openagent_cli knowledge directories create 1 --name "Policies"
deepflow_openagent_cli knowledge files create 1 \
  --directory-id 2 --name "Product Manual" --custom-version v1 \
  --original ./manual.pdf --markdown ./manual.md
deepflow_openagent_cli knowledge files list 1 --markdown-filter has-missing
deepflow_openagent_cli knowledge versions upload 1 3 \
  --custom-version v2 --original ./manual-v2.pdf
deepflow_openagent_cli knowledge versions attach-markdown 1 3 4 \
  --markdown ./manual-v2.md
deepflow_openagent_cli knowledge versions set-current 1 3 4
deepflow_openagent_cli knowledge versions original 1 3 4 --output ./manual-v2.pdf
deepflow_openagent_cli knowledge versions markdown 1 3 4 --output ./manual-v2.md

deepflow_openagent_cli chat 1 --message "Hello"
deepflow_openagent_cli steps 1 42
deepflow_openagent_cli steps get 1 42 100
deepflow_openagent_cli steps feedback 1 42 100 --rating like --comment "Helpful answer"

# Python code tool (create → update config → debug execute)
deepflow_openagent_cli tools create 1 --name order_query --tool-type python_code
deepflow_openagent_cli tools update 1 2 --json '{"config":{"code":"import openagent\nopenagent.set_output(openagent.args)","parameters_json":"{\"type\":\"object\",\"properties\":{\"order_id\":{\"type\":\"string\"}},\"required\":[\"order_id\"]}"}}'
deepflow_openagent_cli tools execute 1 2 --json '{"brief":"查订单","order_id":"A1"}'

Development (build wheel/sdist locally)

From this directory:

pip install -e ".[dev]"
pytest
python -m build

Upload to PyPI (use a new API token; never commit tokens):

python -m twine upload dist/*

When prompted, username is __token__ and password is the token value.