docs(cli): add Harness command reference (zh/en) by yaozheng-fang · Pull Request #599 · volcengine/veadk-python · GitHub
Skip to content

docs(cli): add Harness command reference (zh/en)#599

Merged
yaozheng-fang merged 1 commit into
mainfrom
docs/harness-cli
Jun 11, 2026
Merged

docs(cli): add Harness command reference (zh/en)#599
yaozheng-fang merged 1 commit into
mainfrom
docs/harness-cli

Conversation

@yaozheng-fang

Copy link
Copy Markdown
Collaborator

What

Adds a CLI documentation page for the veadk agentkit harness commands, the HTTP client for a deployed Harness server (veadk.cloud.harness_app).

Pages

  • docs/content/docs/cli/harness-cli.mdx (中文)
  • docs/content/docs/cli/harness-cli.en.mdx (English)

Wired into CLI nav: meta.json / meta.en.json page order + a card in index.mdx / index.en.mdx.

Content

Sourced from the actual implementation in veadk/cli/cli_agentkit.py and veadk/cloud/harness_app.py:

  • Concept — a harness = model + system prompt + tools + skills, registered/invoked at runtime against a deployed server.
  • Connection options--url/HARNESS_URL, --key/HARNESS_KEY, HARNESS_TIMEOUT (default 600s).
  • harness add — full option table; notes the 400-on-duplicate behavior (no overwrite).
  • harness invoke — positional MESSAGE, --harness, --user-id/--session-id, plus the one-time harness override (any of --model-name/--system-prompt/--tools/--skills applies to that single call only).
  • Links to the end-to-end 14_harness_server_on_agentkit example.

Notes

  • Commands are documented under veadk agentkit harness ... since harness is a subgroup of the agentkit group, not a top-level command.
  • biome passes on the JSON; .mdx is excluded by the docs biome config (same as the existing agentkit-cli.mdx).

Document the `veadk agentkit harness add` / `invoke` client commands for a
deployed Harness server: connection options (--url/--key, HARNESS_URL/
HARNESS_KEY/HARNESS_TIMEOUT), full option tables, and the one-time harness
override on invoke. Wire the new page into the CLI nav (meta + index cards),
bilingual.
@yaozheng-fang yaozheng-fang merged commit a861ede into main Jun 11, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants