跳转到内容

CLI

AicippY CLI 选项和命令。

AicippY CLI 在不带任何参数运行时,默认启动 TUI

Terminal window
aicippy-code

但它也接受本页面中记录的命令,使您可以通过编程方式与 AicippY 进行交互。

Terminal window
aicippy-code run "Explain how closures work in JavaScript"

tui

启动 AicippY 终端用户界面。

Terminal window
aicippy-code [project]

标志

标志简写描述
--continue-c继续上一个会话
--session-s要继续的会话 ID
--fork继续时分叉会话(与 --continue--session 配合使用)
--prompt要使用的提示词
--model-m要使用的模型,格式为 provider/model
--agent要使用的代理
--port监听端口
--hostname监听主机名

命令

AicippY CLI 还提供以下命令。


agent

管理 AicippY 的代理。

Terminal window
aicippy-code agent [command]

attach

将终端连接到已通过 serveweb 命令启动的 AicippY 后端服务器。

Terminal window
aicippy-code attach [url]

这允许将 TUI 与远程 AicippY 后端配合使用。例如:

Terminal window
# Start the backend server for web/mobile access
aicippy-code web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backend
aicippy-code attach http://10.20.30.40:4096

标志

标志简写描述
--dir启动 TUI 的工作目录
--continue-c继续上一个会话
--session-s要继续的会话 ID
--fork继续时派生会话(与 --continue--session 一起使用)
--password-p基本认证密码(默认使用 AICIPPY_CODE_SERVER_PASSWORD
--username-u基本认证用户名(默认使用 AICIPPY_CODE_SERVER_USERNAMEaicippy-code

create

使用自定义配置创建新的代理。

Terminal window
aicippy-code agent create

此命令将引导您使用自定义系统提示词和工具配置来创建新的代理。


list

列出所有可用的代理。

Terminal window
aicippy-code agent list

auth

管理提供商的凭据和登录信息的命令。

Terminal window
aicippy-code auth [command]

login

AicippY 基于 AicippY Models 的提供商列表运行,因此您可以使用 aicippy-code auth login 为任何想要使用的提供商配置 API 密钥。密钥存储在 ~/.local/share/aicippy-code/auth.json 中。

Terminal window
aicippy-code auth login

AicippY 启动时会从凭据文件加载提供商信息,同时也会加载环境变量或项目中 .env 文件中定义的密钥。


list

列出凭据文件中存储的所有已认证提供商。

Terminal window
aicippy-code auth list

或使用简写版本。

Terminal window
aicippy-code auth ls

logout

从凭据文件中清除提供商信息以完成登出。

Terminal window
aicippy-code auth logout

github

管理用于仓库自动化的 GitHub 代理。

Terminal window
aicippy-code github [command]

install

在您的仓库中安装 GitHub 代理。

Terminal window
aicippy-code github install

此命令会设置必要的 GitHub Actions 工作流并引导您完成配置过程。了解更多


run

运行 GitHub 代理。通常在 GitHub Actions 中使用。

Terminal window
aicippy-code github run
标志
标志描述
--event用于运行代理的 GitHub 模拟事件
--tokenGitHub 个人访问令牌

mcp

管理 Model Context Protocol 服务器。

Terminal window
aicippy-code mcp [command]

add

将 MCP 服务器添加到您的配置中。

Terminal window
aicippy-code mcp add

此命令将引导您添加本地或远程 MCP 服务器。


list

列出所有已配置的 MCP 服务器及其连接状态。

Terminal window
aicippy-code mcp list

或使用简写版本。

Terminal window
aicippy-code mcp ls

auth

对支持 OAuth 的 MCP 服务器进行认证。

Terminal window
aicippy-code mcp auth [name]

如果您不提供服务器名称,系统将提示您从可用的支持 OAuth 的服务器中进行选择。

您还可以列出支持 OAuth 的服务器及其认证状态。

Terminal window
aicippy-code mcp auth list

或使用简写版本。

Terminal window
aicippy-code mcp auth ls

logout

移除 MCP 服务器的 OAuth 凭据。

Terminal window
aicippy-code mcp logout [name]

debug

调试 MCP 服务器的 OAuth 连接问题。

Terminal window
aicippy-code mcp debug <name>

models

列出已配置提供商的所有可用模型。

Terminal window
aicippy-code models [provider]

此命令以 provider/model 的格式显示所有已配置提供商中可用的模型。

这对于确定在配置文件中使用的确切模型名称非常有用。

您可以选择传入提供商 ID 来按提供商筛选模型。

Terminal window
aicippy-code models anthropic

标志

标志描述
--refresh从 models.aicippy.com 刷新模型缓存
--verbose使用更详细的模型输出(包含费用等元数据)

使用 --refresh 标志可以更新缓存的模型列表。当提供商新增了模型并且您希望在 AicippY 中看到它们时,此功能非常有用。

Terminal window
aicippy-code models --refresh

run

以非交互模式运行 AicippY,直接传入提示词。

Terminal window
aicippy-code run [message..]

这对于脚本编写、自动化或无需启动完整 TUI 即可快速获取答案的场景非常有用。例如:

Terminal window
aicippy-code run Explain the use of context in Go

您还可以连接到正在运行的 aicippy-code serve 实例,以避免每次运行时 MCP 服务器的冷启动时间:

Terminal window
# Start a headless server in one terminal
aicippy-code serve
# In another terminal, run commands that attach to it
aicippy-code run --attach http://localhost:4096 "Explain async/await in JavaScript"

标志

标志简写描述
--command要运行的命令,使用 message 作为参数
--continue-c继续上一个会话
--session-s要继续的会话 ID
--fork继续时分叉会话(与 --continue--session 配合使用)
--share分享会话
--model-m要使用的模型,格式为 provider/model
--agent要使用的代理
--file-f附加到消息的文件
--format格式:default(格式化输出)或 json(原始 JSON 事件)
--title会话标题(未提供值时使用截断的提示词)
--attach连接到正在运行的 aicippy-code 服务器(例如 http://localhost:4096)
--password-p基本认证密码(默认使用 AICIPPY_CODE_SERVER_PASSWORD
--username-u基本认证用户名(默认使用 AICIPPY_CODE_SERVER_USERNAMEaicippy-code
--dir运行目录,或附加时远程服务器上的路径
--variant模型变体(特定于提供商的推理级别)
--thinking显示思考块
--port本地服务器端口(默认为随机端口)

serve

启动无界面的 AicippY 服务器以提供 API 访问。查看服务器文档了解完整的 HTTP 接口。

Terminal window
aicippy-code serve

此命令启动一个 HTTP 服务器,提供对 AicippY 功能的 API 访问,无需 TUI 界面。设置 AICIPPY_CODE_SERVER_PASSWORD 可启用 HTTP 基本认证(用户名默认为 aicippy-code)。

标志

标志描述
--port监听端口
--hostname监听主机名
--mdns启用 mDNS 发现
--cors允许 CORS 的额外浏览器来源

session

管理 AicippY 会话。

Terminal window
aicippy-code session [command]

list

列出所有 AicippY 会话。

Terminal window
aicippy-code session list
标志
标志简写描述
--max-count-n限制为最近 N 个会话
--format输出格式:table 或 json(默认 table)

stats

显示 AicippY 会话的 Token 用量和费用统计信息。

Terminal window
aicippy-code stats

标志

标志描述
--days显示最近 N 天的统计信息(默认为所有时间)
--tools显示的工具数量(默认为全部)
--models显示模型用量明细(默认隐藏)。传入数字可显示前 N 个
--project按项目筛选(默认为所有项目,传入空字符串表示当前项目)

export

将会话数据导出为 JSON。

Terminal window
aicippy-code export [sessionID]

如果您不提供会话 ID,系统将提示您从可用的会话中进行选择。


import

从 JSON 文件或 AicippY 分享链接导入会话数据。

Terminal window
aicippy-code import <file>

您可以从本地文件或 AicippY 分享链接导入。

Terminal window
aicippy-code import session.json
aicippy-code import https://opncd.ai/s/abc123

web

启动带有 Web 界面的无界面 AicippY 服务器。

Terminal window
aicippy-code web

此命令启动一个 HTTP 服务器并打开浏览器,通过 Web 界面访问 AicippY。设置 AICIPPY_CODE_SERVER_PASSWORD 可启用 HTTP 基本认证(用户名默认为 aicippy-code)。

标志

标志描述
--port监听端口
--hostname监听主机名
--mdns启用 mDNS 发现
--cors允许 CORS 的额外浏览器来源

acp

启动 ACP(Agent Client Protocol)服务器。

Terminal window
aicippy-code acp

此命令启动一个通过 stdin/stdout 使用 nd-JSON 进行通信的 ACP 服务器。

标志

标志描述
--cwd工作目录
--port监听端口
--hostname监听主机名

uninstall

卸载 AicippY 并删除所有相关文件。

Terminal window
aicippy-code uninstall

标志

标志简写描述
--keep-config-c保留配置文件
--keep-data-d保留会话数据和快照
--dry-run显示将被删除的内容但不实际删除
--force-f跳过确认提示

upgrade

将 AicippY 更新到最新版本或指定版本。

Terminal window
aicippy-code upgrade [target]

更新到最新版本。

Terminal window
aicippy-code upgrade

更新到指定版本。

Terminal window
aicippy-code upgrade v0.1.48

标志

标志简写描述
--method-m使用的安装方式:curl、npm、pnpm、bun、brew

全局标志

AicippY CLI 接受以下全局标志。

标志简写描述
--help-h显示帮助信息
--version-v打印版本号
--print-logs将日志输出到 stderr
--log-level日志级别(DEBUG、INFO、WARN、ERROR)

环境变量

AicippY 可以通过环境变量进行配置。

变量类型描述
AICIPPY_CODE_AUTO_SHAREboolean自动分享会话
AICIPPY_CODE_GIT_BASH_PATHstringWindows 上 Git Bash 可执行文件的路径
AICIPPY_CODE_CONFIGstring配置文件路径
AICIPPY_CODE_TUI_CONFIGstringTUI 配置文件路径
AICIPPY_CODE_CONFIG_DIRstring配置目录路径
AICIPPY_CODE_CONFIG_CONTENTstring内联 JSON 配置内容
AICIPPY_CODE_DISABLE_AUTOUPDATEboolean禁用自动更新检查
AICIPPY_CODE_DISABLE_PRUNEboolean禁用旧数据清理
AICIPPY_CODE_DISABLE_TERMINAL_TITLEboolean禁用自动终端标题更新
AICIPPY_CODE_PERMISSIONstring内联 JSON 权限配置
AICIPPY_CODE_DISABLE_DEFAULT_PLUGINSboolean禁用默认插件
AICIPPY_CODE_DISABLE_LSP_DOWNLOADboolean禁用 LSP 服务器自动下载
AICIPPY_CODE_ENABLE_EXPERIMENTAL_MODELSboolean启用实验性模型
AICIPPY_CODE_DISABLE_AUTOCOMPACTboolean禁用自动上下文压缩
AICIPPY_CODE_DISABLE_CLAUDE_CODEboolean禁用读取 .claude(提示词 + 技能)
AICIPPY_CODE_DISABLE_CLAUDE_CODE_PROMPTboolean禁用读取 ~/.claude/CLAUDE.md
AICIPPY_CODE_DISABLE_CLAUDE_CODE_SKILLSboolean禁用加载 .claude/skills
AICIPPY_CODE_DISABLE_MODELS_FETCHboolean禁用从远程源获取模型
AICIPPY_CODE_FAKE_VCSstring用于测试目的的模拟 VCS 提供商
AICIPPY_CODE_CLIENTstring客户端标识符(默认为 cli
AICIPPY_CODE_ENABLE_EXAboolean启用 Exa 网络搜索工具
AICIPPY_CODE_SERVER_PASSWORDstringserve/web 启用基本认证
AICIPPY_CODE_SERVER_USERNAMEstring覆盖基本认证用户名(默认为 aicippy-code
AICIPPY_CODE_MODELS_URLstring自定义模型配置获取 URL

实验性功能

这些环境变量用于启用可能会更改或移除的实验性功能。

变量类型描述
AICIPPY_CODE_EXPERIMENTALboolean启用受总开关控制的实验性功能
AICIPPY_CODE_EXPERIMENTAL_ICON_DISCOVERYboolean启用图标发现
AICIPPY_CODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECTboolean禁用 TUI 中的选中即复制
AICIPPY_CODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MSnumberbash 命令的默认超时时间(毫秒)
AICIPPY_CODE_EXPERIMENTAL_OUTPUT_TOKEN_MAXnumberLLM 响应的最大输出 Token 数
AICIPPY_CODE_EXPERIMENTAL_FILEWATCHERboolean启用整个目录的文件监听器
AICIPPY_CODE_EXPERIMENTAL_OXFMTboolean启用 oxfmt 格式化器
AICIPPY_CODE_EXPERIMENTAL_LSP_TOOLboolean启用实验性 LSP 工具
AICIPPY_CODE_EXPERIMENTAL_DISABLE_FILEWATCHERboolean禁用文件监听器
AICIPPY_CODE_EXPERIMENTAL_EXAboolean启用实验性 Exa 功能
AICIPPY_CODE_EXPERIMENTAL_LSP_TYboolean为 python 文件启用 TY LSP
AICIPPY_CODE_EXPERIMENTAL_PLAN_MODEboolean启用计划模式
AICIPPY_CODE_EXPERIMENTAL_BACKGROUND_SUBAGENTSboolean启用后台子代理任务
AICIPPY_CODE_EXPERIMENTAL_EVENT_SYSTEMboolean启用实验性事件系统
AICIPPY_CODE_EXPERIMENTAL_NATIVE_LLMboolean启用原生 LLM 请求路径
AICIPPY_CODE_EXPERIMENTAL_PARALLELboolean启用并行 Web 搜索执行
AICIPPY_CODE_EXPERIMENTAL_SCOUTboolean启用 Scout 子代理
AICIPPY_CODE_EXPERIMENTAL_WORKSPACESboolean启用工作区支持