136 lines
4.4 KiB
YAML
136 lines
4.4 KiB
YAML
# ============================================================
|
||
# AgentDock 适配器 · Crush（Charm）（Wave 3）
|
||
# 数据依据：调研底稿 agent-cli-survey-2026-08-24.md + 架构 §3.3
|
||
# 注意：crushrc 是 Bash 语法配置，走 Wave 1 专用解析器（只识别内建赋值，不执行任意脚本）。
|
||
# ============================================================
|
||
id: crush
|
||
name: Crush
|
||
name_zh: Crush
|
||
vendor: Charm
|
||
status: available
|
||
adapter_version: 1.1.0
|
||
license: FSL（Functional Source License，仅引导官方安装、不重分发源码）
|
||
|
||
platforms:
|
||
windows:
|
||
architectures: [x64]
|
||
notes: winget / scoop / Releases 渠道
|
||
linux:
|
||
distributions: [ubuntu]
|
||
architectures: [x64]
|
||
|
||
official:
|
||
homepage: https://github.com/charmbracelet/crush
|
||
docs: https://github.com/charmbracelet/crush
|
||
allowed_hosts: [github.com, charm.sh]
|
||
|
||
runtime_deps: []
|
||
|
||
install:
|
||
preferred: winget
|
||
channels:
|
||
- id: winget
|
||
platforms: [windows]
|
||
command: [winget, install, charmbracelet.crush]
|
||
package: charmbracelet.crush
|
||
elevate: never
|
||
post_checks: [detect]
|
||
- id: apt
|
||
platforms: [linux]
|
||
command: [sudo, apt-get, install, -y, crush]
|
||
package: crush
|
||
elevate: required
|
||
elevate_reason_zh: 官方 apt 仓库（GPG）安装需要管理员权限
|
||
post_checks: [detect]
|
||
- id: github_release
|
||
platforms: [windows, linux]
|
||
package: crush
|
||
elevate: never
|
||
post_checks: [detect]
|
||
|
||
detect:
|
||
executable: crush
|
||
version_args: ["--version"]
|
||
version_unconfirmed: true
|
||
|
||
update:
|
||
method: winget_upgrade
|
||
command: [winget, upgrade, charmbracelet.crush]
|
||
|
||
uninstall:
|
||
method: package_manager
|
||
command: [winget, uninstall, charmbracelet.crush]
|
||
keep_config_default: true
|
||
|
||
authorization:
|
||
modes:
|
||
- mode: api_key
|
||
env_keys: [OPENAI_API_KEY, ANTHROPIC_API_KEY]
|
||
notes_zh: 各家模型 API Key（环境变量注入）；crushrc 内亦可用 export 语句
|
||
|
||
# 配置机制：crushrc 是 Bash 语法配置（~/.config/crush/crushrc）。
|
||
# 走 Wave 1 专用解析器：只识别内建赋值（export KEY=value 等），不执行任意脚本，未知行原样保留。
|
||
configuration:
|
||
files:
|
||
- path: "~/.config/crush/crushrc"
|
||
format: crushrc
|
||
scope: user
|
||
environment:
|
||
- key: OPENAI_API_KEY
|
||
sensitive: true
|
||
maps_to_field: api_key
|
||
fields:
|
||
- id: api_key
|
||
label_zh: API Key
|
||
group: auth
|
||
help_zh: 存入系统密钥库（对应 OPENAI_API_KEY 等环境变量）；crushrc 内也可用 export 注入
|
||
required: false
|
||
sensitive: true
|
||
type: string
|
||
storage: keyring
|
||
docs_url: https://github.com/charmbracelet/crush
|
||
|
||
diagnostics:
|
||
- rule_id: path.not_installed
|
||
- rule_id: path.not_in_path
|
||
- rule_id: version_conflict.multiple_copies
|
||
- rule_id: config.corrupt
|
||
|
||
documentation:
|
||
quickstart_zh: 安装后配置 API Key，运行 `crush` 进入会话，或用 `crush -p "提示词"` 无头执行。
|
||
install_zh: Windows 推荐 winget `charmbracelet.crush`；Ubuntu 用官方 apt 仓库（GPG）。备选 scoop / GitHub Releases（本适配器 npm 渠道按调研底稿标记为备选，非默认）。
|
||
auth_zh: 仅 API Key（环境变量注入）：OPENAI_API_KEY / ANTHROPIC_API_KEY 等各家模型 Key。crushrc 内也可用 export 语句。
|
||
commands:
|
||
- cmd: crush
|
||
desc_zh: 启动交互式会话
|
||
- cmd: crush "提示词"
|
||
desc_zh: 直接以提示词启动
|
||
- cmd: crush -p "提示词"
|
||
desc_zh: 无头单次执行
|
||
- cmd: crush --session <名称>
|
||
desc_zh: 指定会话名
|
||
- cmd: crush --continue
|
||
desc_zh: 续接最近会话
|
||
- cmd: crush --list-sessions
|
||
desc_zh: 列出会话
|
||
- cmd: crush --model <模型>
|
||
desc_zh: 指定模型
|
||
- cmd: crush --version
|
||
desc_zh: 显示版本号
|
||
params:
|
||
- param: -p / --print
|
||
desc_zh: 无头模式单次执行
|
||
- param: --session
|
||
desc_zh: 指定会话名
|
||
- param: --continue
|
||
desc_zh: 续接最近会话
|
||
- param: --model
|
||
desc_zh: 指定模型
|
||
- param: --list-sessions
|
||
desc_zh: 列出会话
|
||
updated_at: "2026-08-25"
|
||
risks_zh:
|
||
- crushrc 是 Bash 语法配置，AgentDock 走专用解析器，只识别内建赋值、不执行任意脚本
|
||
- --version 官方未确认，适配器已标 version_unconfirmed（命令细节以 `crush --help` 实测为准）
|
||
- FSL 许可：仅引导官方安装，不重分发源码、不修改二进制
|