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"

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.1.tar.gz (12.9 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.1-py3-none-any.whl (11.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: deepflow_openagent_cli-0.1.1.tar.gz
  • Upload date:
  • Size: 12.9 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.1.tar.gz
Algorithm Hash digest
SHA256 eb4ddec88275e7d1d502722da19972195ff4a470bb9f3463dcb4821c3b38edf6
MD5 e99b3e95d494ece22d2c198c7b186d85
BLAKE2b-256 2b28a05514ea7ae7810360feadd69059b41f63fb7854ea92b832b412bd48325f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for deepflow_openagent_cli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2df6edd9981774da918e79cb9cc65ad10481f3a65e5cc3a2ec86d6fc0b18ff69
MD5 3bc0aff2827374a260bcb2574d5541fa
BLAKE2b-256 97e68bac1353ac3747c271676db7fef5c2d9a287de898db5875f19496038f128

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