Files
myagents/README.md
T

3.4 KiB
Raw Blame History

MyAgents

一个统一的 AI coding agent 启动器,封装 Claude Code、Kimi Code CLI 等工具。

功能

  • 🤖 多 Agent 统一入口myagents claude / myagents kimi
  • 🚀 独立快捷命令myclaudemykimi
  • 📂 自动 Workspace 解析:默认 ~/workspace,可通过环境变量覆盖
  • 📝 Session 管理--list 列出可恢复会话
  • ➡️ 原生参数透传:任意底层 agent 支持的参数直接透传

项目结构

myagents/
├── myagents/
│   ├── cli.py            # myagents 统一入口
│   ├── entrypoints.py    # myclaude / mykimi 独立入口
│   ├── launcher.py       # Agent 启动逻辑
│   ├── project_root.py   # 项目/工作区根目录解析
│   └── commands/         # update / upgrade 子命令
├── tests/
├── templates/            # workspace 模板
├── pyproject.toml
├── Makefile
└── README.md

安装

前置依赖

工具 版本要求 说明
Python 3.10+ 项目运行环境
make - 构建工具(macOS/Linux 通常自带)
git - 代码仓库管理
uv 或 pip - Python 包管理器,推荐 uv

克隆并安装

git clone <repository-url> /path/to/myagents
cd /path/to/myagents
make install

make install 会:

  1. 同步/创建虚拟环境并做可编辑安装
  2. ~/.local/bin/ 创建 myagentsmyclaudemykimi 符号链接
  3. 安装 shell 补全(zsh/bash

请确保 ~/.local/binPATH 中。移除链接:make uninstall

💡 提示:没有 uv 时会创建项目 .venv 并用其中的 pip 做可编辑安装。

命令用法

# 统一入口
myagents                          # 显示 help
myagents claude                   # 启动 Claude Code
myagents claude --cwd .           # 指定工作目录
myagents claude -l                # 列出可恢复 sessions
myagents claude -r <session-id>   # 恢复指定 session
myagents kimi                     # 启动 Kimi Code CLI
myagents kimi -S <session-id>     # 恢复 Kimi session
myagents update                   # 重装 myagents 并同步 workspace 链接
myagents upgrade                  # update 别名

# 独立入口(与上面完全等价)
myclaude
myclaude --cwd . -r <session-id>
mykimi
mykimi -S <session-id>

各后端原生参数会原样透传。例如 Kimi npm 版支持 --session-ccontinue)、-yyolo)等,直接加在命令后即可。

配置

环境变量 说明
MYAGENTS_PROJECT_ROOT 覆盖项目根目录自动检测
MYAGENTS_WORKSPACE_ROOT 覆盖 workspace 根目录,默认 ~/workspace

设置示例:

export MYAGENTS_WORKSPACE_ROOT="/your/custom/workspace"

Shell 补全(可选)

~/.zshrc~/.bashrc 中加入:

if command -v myagents >/dev/null 2>&1; then
  eval "$(_MYAGENTS_COMPLETE=zsh_source myagents)"
fi

Bash 将 zsh_source 换成 bash_source。保存后 source 配置文件。

开发

# 运行测试
python3 -m pytest tests/ -q

# 代码检查
python3 -m ruff check myagents tests scripts

完整部署指南

如果你要部署的是小荷助理完整环境(含 Claude Code、cc-switch、Metabot、飞书机器人等),请参见 xiaohe-agent 部署文档

License

MIT