CLI Anything Hiagent

cli-anything-hiagent

Command-line interface for the HiAgent Python SDK built by Hiagent. This CLI provides programmatic access to HiAgent's Observe service, including API Token management and Trace/Span observability.

Installation

pip install cli-anything-hiagent

Installation from source

uv pip install -e agent-harness

Prerequisites:

• HiAgent Python SDK (hiagent-api, hiagent-components)
• Volcano Engine credentials (request signing)
  • VOLC_ACCESSKEY / VOLC_SECRETKEY environment variables, or
  • ~/.volc/.env

Configuration

Set up credentials using environment variables:

export VOLC_ACCESSKEY="..."
export VOLC_SECRETKEY="..."
export HIAGENT_TOP_ENDPOINT="https://open.volcengineapi.com"

Observe Commands

Observe service for API Token management and Trace/Span observability:

# Create API Token
cli-anything-hiagent observe token create \
  --workspace-id ws-123 \
  --custom-app-id app-456

# List trace spans
cli-anything-hiagent observe trace list \
  --workspace-id ws-123 \
  --page-size 10 \
  --sort-by StartTime \
  --sort-order Desc

# List trace spans with pagination
cli-anything-hiagent observe trace list \
  --workspace-id ws-123 \
  --page-size 20 \
  --last-id last-doc-id \
  --sort-by Latency \
  --sort-order Asc

Observe Command Options

token create:

• --workspace-id (required): Workspace ID
• --custom-app-id (required): Custom App ID

trace list:

• --workspace-id (required): Workspace ID
• --page-size: Page size (default: 10)
• --last-id: Last ID for pagination
• --sort-by: Sort field (StartTime, Latency, LatencyFirstResp, TotalTokens)
• --sort-order: Sort order (Asc, Desc)

JSON Output Mode

Use --json flag for machine-readable output (essential for AI agents):

cli-anything-hiagent --json observe trace list --workspace-id ws-123

JSON output format:

{
  "success": true,
  "message": "Operation completed",
  "data": { ... }
}

Return Codes

• 0 - Success
• 1 - Error (with error message in message field of JSON output)

Error Handling

All commands output errors in both human-readable and JSON formats:

# JSON error
$ cli-anything-hiagent --json observe trace list --workspace-id invalid-ws
{
  "success": false,
  "message": "...",
  "data": null
}

System Requirements

• Python >= 3.10
• HiAgent API access with valid Volcano Engine credentials
• Network access to HiAgent endpoints

License

Apache-2.0

Generated by Hiagent