参考
命令行工具的全局参数、环境变量、配置文件、shell 补全和版本。
全局参数
每个命令都接受这些参数。
| 参数 | 作用 |
|---|---|
-p、--project | 项目:它的 id、slug 或名称。默认:用 lyrelog use 选择的项目。 |
--url | 控制台的地址。默认为 https://app.lyrelog.com,或 LYRELOG_URL。 |
--json | 输出 JSON,即使在终端中 |
--human | 输出表格和颜色,即使输出到管道 |
--no-color | 不使用颜色(也可以用 NO_COLOR=1) |
-h、--help | 命令的帮助,附带示例 |
环境变量
| 变量 | 作用 |
|---|---|
LYRELOG_TOKEN | 访问令牌(lyr_tok_...,来自 lyrelog tokens create 或你的账户页面)或 CLI 会话 token。优先于已保存的登录。参见脚本和 CI。 |
LYRELOG_URL | 控制台的地址。--url 优先于它。 |
LYRELOG_CONFIG_DIR | 存放配置文件的文件夹 |
LYRELOG_THEME | dark 或 light,在工具误判终端背景色时使用 |
LYRELOG_AGENT | 任意值:输出 JSON,与编程 agent 运行时相同 |
NO_COLOR | 任意值:不使用颜色 |
BROWSER | lyrelog login 和 lyrelog open 使用的浏览器;none 表示不使用浏览器 |
工具还会读取编程 agent 和 CI 设置的变量,以决定输出 JSON 还是表格。参见 JSON 还是表格。
配置文件
工具把配置保存在一个 JSON 文件 config.json 中,位置如下:
| 文件夹 | |
|---|---|
| macOS 和 Linux | $XDG_CONFIG_HOME/lyrelog(如已设置该变量),否则为 ~/.config/lyrelog |
| Windows | %AppData%\lyrelog |
| 任何系统 | LYRELOG_CONFIG_DIR(如已设置) |
这个文件只有你能读取(权限 0600,位于 0700 的文件夹中),并且是一次写完的,所以不会出现只写了一半的情况。它包含:
| 字段 | 含义 |
|---|---|
url | 在 --url 和 LYRELOG_URL 都没有指定时使用的服务器:你最后登录的那个 |
hosts | 每个服务器一项,以其地址为键 |
hosts.*.token | 会话。工具从不输出它。 |
hosts.*.expires_at | 会话最晚何时结束(Unix 秒) |
hosts.*.user_email、hosts.*.user_name | 会话属于谁 |
hosts.*.project、hosts.*.project_name | 默认项目的 id,以及在消息中显示的项目名称 |
{
"url": "https://app.lyrelog.com",
"hosts": {
"https://app.lyrelog.com": {
"token": "…",
"expires_at": 1797714620,
"user_email": "alex@example.com",
"user_name": "Alex Rivera",
"project": "e8bc11c6e22f",
"project_name": "Tilefall"
}
}
}这个 token 相当于一个会话,和浏览器的 cookie 一样:在它结束之前,任何复制了它的人都能以你的身份操作。lyrelog logout
会在服务器上结束它,并把它从文件中移除。
退出码
0 表示成功;其他值说明出了什么问题(2 表示参数错误,3 表示未登录,4 表示需要近期登录,6 表示未找到……)。 完整的表格见供 agent 和脚本使用。
Shell 补全
lyrelog completion 会输出 bash、zsh、fish 或 powershell 的补全脚本。每种 shell 对应的 --help 都会说明该放在哪里。
以 zsh 为例:
source <(lyrelog completion zsh) # this shell only
lyrelog completion zsh > "$(brew --prefix)/share/zsh/site-functions/_lyrelog" # macOS, every shell
lyrelog completion zsh > "${fpath[1]}/_lyrelog" # Linux, every shell补全需要在 ~/.zshrc 中加入 autoload -U compinit; compinit。之后请打开一个新的 shell。
版本
lyrelog versionlyrelog v0.1.0 (4678ef1, built 2026-11-19, go1.27.4, darwin/arm64)它会显示版本号(来自发布版本,或 go install 获取的版本)、构建信息中已知的 commit 和构建日期,以及构建时使用的 Go 版本和目标系统。
没有版本号的构建显示 dev。JSON 格式为:{"version","commit","date","go","os","arch"}。