Skip to main content

Command-line client for OpenAgent OpenAPI (agents, conversations, SSE chat, tools, channels, knowledge bases).

Project description

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

Method Variable / flag
Host OPENAGENT_HOST or --host
API key OPENAGENT_API_KEY or --api-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
deepflow_openagent_cli chat 1 --message "Hello"
deepflow_openagent_cli steps 1 42
deepflow_openagent_cli steps get 1 42 100

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.

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

deepflow_openagent_cli-0.1.3.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

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

deepflow_openagent_cli-0.1.3-py3-none-any.whl (11.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: deepflow_openagent_cli-0.1.3.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for deepflow_openagent_cli-0.1.3.tar.gz
Algorithm Hash digest
SHA256 20d53ce1fa947edbcc0104198cfb72dd0f32424b7076f3553fd79a3b4ef7295f
MD5 035ad81b6e75a06ba467b777207651c4
BLAKE2b-256 278dc6af985f010d1c6908550ed0078e74bc3ada82bfe758f29dd090dbf44014

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for deepflow_openagent_cli-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 23b18757422f4717f07a67bff748a91c2b1f24691f75676f633fd7612d68b2f0
MD5 c06076011831fa474e5fcd3762c6cced
BLAKE2b-256 8e36ca9ac462e87daf00441e73cf1d9c9df7960d7c581e80f4b3705c0c5b09dc

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