Skip to main content

珊瑚平台 Python CLI 示例

Project description

coral-cli

这是一个面向珊瑚平台的 Python CLI。当前主要用于调用珊瑚平台 API,不再依赖账号密码登录,而是直接从环境变量读取鉴权信息。

安装

pip install -e .

如果已经发布到包源,也可以直接安装:

pip install coral-cli

环境变量

CLI 启动后会优先读取以下环境变量:

  • ACCESSKEY,也兼容 CORAL_ACCESSKEY
  • ACC_ID,也兼容 CORAL_ACC_ID

示例:

export ACCESSKEY='your-accesskey'
export ACC_ID='vic.lv'

命令

coral-cli config
coral-cli zhipu-search --app-id 2046036834380091394 --conversation-id 2046040995337003010 --input '添可'
coral-cli project

coral-cli config 会检查当前环境变量是否存在,并以脱敏方式输出配置摘要。

coral-cli zhipu-search 会调用下面这个接口:

https://coral-test.ecovacs.cn/app-platform/api/app/v1/chat/completions

等价调用示例:

coral-cli zhipu-search \
	--app-id 2046036834380091394 \
	--conversation-id 2046040995337003010 \
	--input '添可' \
	--tools-call-enabled 1 \
	--no-stream

这个命令会自动注入以下请求头:

accesskey: 从 ACCESSKEY 或 CORAL_ACCESSKEY 读取
ACC_ID: 从 ACC_ID 或 CORAL_ACC_ID 读取
Content-Type: application/json

Agent 使用建议

像 openclaw 这样的 Agent 在调用前,不应再要求用户登录,而应先确认运行环境里已经注入了 ACCESSKEYACC_ID。然后按下面顺序执行:

coral-cli config
coral-cli zhipu-search --app-id <app-id> --conversation-id <conversation-id> --input '<query>'

如果环境变量不存在,Agent 应提示用户在宿主环境中设置,而不是在 CLI 内部交互式索取或持久化保存。

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

coral_cli-0.1.3.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

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

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for coral_cli-0.1.3.tar.gz
Algorithm Hash digest
SHA256 29e689cca2eb5c44836b4db24067dbb46b382883704f14c2057005871c4fe7cf
MD5 7c4abd6800da47269dab80a641119b36
BLAKE2b-256 51bb63162c1b08bbf2e05c4b20c1310a906f0d91b0fe06442f4eacb8fe60a7c5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: coral_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.10.11

File hashes

Hashes for coral_cli-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9f994cdb4c9d166fe936bb083f5b87b50a4bda9742a8ff5040ab321741635772
MD5 d6d281e1c216f165afd999b83f7b6bff
BLAKE2b-256 981d83bacafabfab227f6091750f26acc2efba22602de59b30d5d76e2a4d5c57

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