lcap-agent-cli

1.7.1 • Public • Published

LCAP Agent CLI

CLI for LCAP Agent - 一个用于文件监控和远程操作的命令行工具。

安装

npm install -g lcap-agent-cli

使用方法

基本用法

lcap-agent-cli /path/to/your/project

参数说明

  • 第一个参数: 工作目录路径(必需)
  • --port, -p: 服务器端口号(默认: 3030)
  • --ignore, -i: 额外的忽略规则,可以多次使用
  • --post-response, -a: 指定在每次AI助手完成回复后自动执行的命令

忽略文件示例

LCAP Agent CLI 默认会忽略以下文件和目录:

  • .git
  • node_modules
  • .DS_Store
  • *~ (临时文件)
  • dist

此外,它还会读取项目中的 .gitignore 文件并应用其中的规则。

如果你想添加额外的忽略规则,可以使用 --ignore 参数:

# 忽略所有 .log 文件
lcap-agent-cli /path/to/project --ignore "*.log"

# 忽略多种文件类型
lcap-agent-cli /path/to/project --ignore "*.log" --ignore "*.tmp" --ignore "build/"

# 使用简写形式
lcap-agent-cli /path/to/project -i "*.log" -i "temp/"

# 指定在每次AI助手回复后执行的命令
lcap-agent-cli /path/to/project --post-response "npm run lint"

# 使用简写形式指定命令
lcap-agent-cli /path/to/project -a "npm test"

忽略规则使用 ignore 库解析,支持与 .gitignore 相同的语法:

  • **/logs - 忽略所有名为 logs 的目录
  • *.log - 忽略所有 .log 文件
  • temp/ - 忽略 temp 目录
  • !important.log - 不忽略 important.log 文件(即使它匹配前面的模式)

自动修复功能

LCAP Agent 提供了自动修复功能,可以在 AI 助手检测到代码错误时自动应用修复建议:

  1. 在 Web 界面中,通过 CLI 连接设置面板可以开启或关闭自动修复功能
  2. 自动修复设置会保存在浏览器的 localStorage 中,下次访问时会自动恢复
  3. 当自动修复开启时,AI 助手会尝试自动修复检测到的代码错误,如编译错误、类型错误等

自动修复功能特别适合以下场景:

  • 在 AI 生成代码后自动修复类型错误
  • 快速解决编译失败问题
  • 自动应用代码风格修复

功能

  • 文件监控:监控工作目录中的文件变化
  • WebSocket 通信:通过 Socket.IO 实时通知文件变化
  • 文件操作:提供读取、写入、删除文件的 API
  • 命令执行:在每次AI助手完成回复后自动执行指定命令,如运行测试、代码检查等
  • 自动修复:自动检测并修复代码错误
  • 远程命令执行:远程执行命令并获取输出

开发

代码规范

项目使用 ESLint 和 Prettier 进行代码规范检查和格式化。在提交代码前,会自动运行 lint-staged 检查修改的文件。

# 手动运行代码检查
npm run lint

# 手动格式化代码
npm run format

许可证

MIT

Readme

Keywords

Package Sidebar

Install

npm i lcap-agent-cli

Weekly Downloads

198

Version

1.7.1

License

none

Unpacked Size

166 kB

Total Files

91

Last publish

Collaborators

  • myronliu347
  • lewis617