文档中心

日志服务

CLI 参考

安装使用日志服务 CLI

本章节介绍如何安装并使用火山引擎日志服务提供的 CLI 工具，以使用静态 AK/SK 凭证为例。

前提条件

已获取火山引擎账号 AK (Access Key ID) 和 SK (Secret Access Key)，详情请参考 Access Key（密钥）管理。

以使用静态 AK/SK 凭证为例，更多认证方式，详情请参考权限认证。

已获取日志服务所在地域的 Region ID 和服务地址（Endpoint）信息。

Region：如 cn-beijing

Endpoint：如 https://tls-cn-beijing.volces.com

快速开始

说明

volclog （默认版本）：面向 Agent、CI 和自动化。

volclog-human ：面向人工交互的 shortcut 层。只有在明确需要 shortcut 时才安装，否则继续使用 volclog。

安装 CLI 工具。

二进制
NPM
Unix 安装脚本需要 curl、tar，以及 sha256sum 或 shasum 。
从目标 Release 下载安装脚本，可在任意目录运行：

tag=volclog-v1.0.5
base_url="https://github.com/volcengine-tls/ve-tls-cli/releases/download/${tag}"
curl -fsSLO "${base_url}/install-binary.sh"
VOLCLOG_BASE_URL="${base_url}" bash install-binary.sh

Unix 安装脚本默认将二进制写入 $HOME/.local/bin，请将其加入 PATH ：

export PATH="$HOME/.local/bin:$PATH"

如需安装人工交互版，可添加 --edition human：

tag=volclog-v1.0.5
base_url="https://github.com/volcengine-tls/ve-tls-cli/releases/download/${tag}"
curl -fsSLO "${base_url}/install-binary.sh"
VOLCLOG_BASE_URL="${base_url}" bash install-binary.sh --edition human

Windows 安装脚本需要 PowerShell。

$tag = "volclog-v1.0.5"
$baseUrl = "https://github.com/volcengine-tls/ve-tls-cli/releases/download/$tag"
Invoke-WebRequest -Uri "$baseUrl/install.ps1" -OutFile install.ps1
powershell -ExecutionPolicy Bypass -File .\install.ps1 -BaseUrl $baseUrl

Windows 安装脚本默认将二进制写入 $env:LOCALAPPDATA\Programs\volclog，请将其加入 PATH：

$env:PATH = "$env:LOCALAPPDATA\Programs\volclog;$env:PATH"
需要 Node.js 18+，通过公开 npm registry 安装当前正式版本：
AI Agent 版：

npm install -g @volcengine-tls/volclog@latest --registry https://registry.npmjs.org/

人工交互版：

npm install -g @volcengine-tls/volclog-human@latest --registry https://registry.npmjs.org/

源码构建。

需要 Go 1.22+。在仓库根目录运行，并安装到用户可写目录：

git clone https://github.com/volcengine-tls/ve-tls-cli.git
cd ve-tls-cli
mkdir -p "$HOME/.local/bin"
go build -o "$HOME/.local/bin/volclog" ./cmd/volclog
export PATH="$HOME/.local/bin:$PATH"

如需人工交互版：

git clone https://github.com/volcengine-tls/ve-tls-cli.git
cd ve-tls-cli
mkdir -p "$HOME/.local/bin"
go build -tags=human -o "$HOME/.local/bin/volclog-human" ./cmd/volclog
export PATH="$HOME/.local/bin:$PATH"

配置凭证。

volclog configure set \
--profile default \
--ak '<access-key-id>' \
--sk '<secret-access-key>' \
--region cn-beijing \
--endpoint https://tls-cn-beijing.volces.com

使用 doctor 验证。

本地 doctor 只检查配置和凭证，不发起网络请求：

volclog --profile default doctor

在线 doctor 会对 TLS endpoint 做一次最小化的连通性检查：

volclog --profile default doctor --online

发送只读请求验证是否可用。

以下命令用于列出日志项目，确认 CLI 能正常访问 TLS 并完成签名。

volclog --profile default tool exec project.describe-projects

安装技能

预置技能

日志服务 CLI 工具在 skills/ 目录预置了 Agent Skill，详情如下：

技能名称

说明

volclog-core

通过 Agent/CI 操作 volclog 时，先读契约再执行，而不是先猜 flags 和请求体。用于实现基于契约的工作流，完成运行时选择器解析、发现/描述/执行路由、信封读取、大结果交付和错误恢复等。

此技能仅用于获取增量知识，即补充 tool describe、workflow describe 之外的 Agent 增量知识，如意图路由、跨 group SOP、运行时语义、恢复策略，以及无状态凭证接入方式。

安装技能

使用如下命令即可安装预置技能：

volclog skill install --dir <agent-skills-dir>

如果只想临时安装一次技能，用后即清理，可以使用 npx：

npx @volcengine-tls/volclog skill install --dir <agent-skills-dir>

常用能力

常用能力	说明
优先使用 Agent 流程	Agent 默认优先使用 tool、workflow、raw 执行流程。 human shortcut 仍保留在 volclog-human 中，但不作为默认主路径。
先确认契约再执行	从 tool describe 或 workflow describe 开始，确认契约后再准备再准备 context 与 input。
写操作优先	发起写操作前，优先使用 --dry-run 预览请求形状和运行时选择，确认无误后再提交变更请求。
大结果优先	当 stdout 可能输出较大结果时，优先使用--output-mode file --output-dir <writable-dir>将结果写入文件。
关注运行时信号	通过 summary.deliveryMode 判断结果最终保留在 stdout，还是已自动或强制写入文件。
按顺序读取错误对象	失败时，依次查看 error.kind、error.code、error.message 和 error.details，定位错误原因。
显式指定 Region	始终显式指定 region，避免依赖 endpoint 反推 region。

最近更新时间：2026.09.10 15:23:01

这个页面对您有帮助吗？

有用

无用