Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

myagent — Local Agent Workbench

本地 Agent 工作台:TUI + Web UI,会话与设置持久化到 SQLite,通过 Anthropic 兼容 API 驱动 Deep Agents / LangGraph。

文档(信任链)docs/README.md — L1 为本文;L2/L3 由本文派发。过时材料在 docs/archive/,不在信任链内。

前置条件

  • Node.js 20+
  • pnpm(仓库锁定 pnpm@11.20.0
  • 可编译原生模块:依赖 better-sqlite3(需本机 C/C++ 工具链;macOS 装 Xcode CLT,Linux 装 build-essential 等)

安装

pnpm install

配置 API Key

任选其一:

# CLI 写入本地设置(推荐)
pnpm myagent settings set apiKey <your-key>

# 或环境变量(优先覆盖)
export ANTHROPIC_API_KEY=sk-...

其它可选项:

pnpm myagent settings set apiUrl https://api.anthropic.com
pnpm myagent settings set model claude-sonnet
pnpm myagent settings set systemPrompt "You are a helpful assistant."

pnpm myagent settings list   # apiKey 脱敏展示

也可设置 ANTHROPIC_BASE_URL / ANTHROPIC_API_URLMYAGENT_MODELMYAGENT_SYSTEM_PROMPT

使用

# 开发:Vite Web(:5173)+ API(:8787),代理 /api
pnpm dev

# 仅 API server(不自动开浏览器)
pnpm --filter @myagent/server dev
#
pnpm myagent-server --no-open

# 仅 TUI
pnpm --filter myagent dev tui
# 或构建后
pnpm myagent tui

# 生产风格:单进程 API + 静态 Web UI(需先 build)
pnpm build
pnpm --filter myagent start web
# 等价:直接起 server 包
pnpm --filter @myagent/server start -- --no-open

默认 Web/API 地址:http://127.0.0.1:8787

数据目录

默认 ~/.myagent/(可用 --data-dir 覆盖):

  • SQLite 会话表、设置
  • LangGraph checkpointer
  • 全局 skills~/.myagent/skills/<skill-name>/SKILL.md

Skills(自动发现与加载)

Agent 启动时自动发现并挂载 skills(deepagents progressive disclosure:目录元数据进 system,正文按需 read_file)。
兼容 .agents 生态约定与 myagent 数据目录;后出现的源覆盖同名 skill

顺序 层级 路径
1 全局 ~/.myagent/skills/(或 --data-dir/skills
2 全局 ~/.agents/skills/
3 项目 <git-root>/.myagent/skills/
4 项目 <git-root>/.agents/skills/

布局:

skills/
  my-skill/
    SKILL.md    # 必填,YAML frontmatter: name + description
    ...         # 可选附属文件
# 列出已发现的 skills
pnpm myagent skills list

TUI / Web 创建 agent 时会一并加载上述目录(目录不存在则跳过,行为与无 skills 时一致)。

开发脚本

命令 说明
pnpm dev 并行 Vite + @myagent/server API
pnpm build 构建 core → server → web → cli
pnpm test core 单测 + server 集成 + cli 集成/PTY
pnpm --filter @myagent/server test 仅 API 集成测试
pnpm --filter myagent test:e2e 仅 PTY 端到端
pnpm typecheck 全包类型检查
pnpm myagent … CLI(tui / web / settings / skills
pnpm myagent-server 独立 API server 入口

包结构:

  • packages/core — Agent、SQLite、settings、skills、bootstrap(@myagent/core
  • packages/server — Hono API、SSE、静态托管、可执行 myagent-server@myagent/server
  • packages/cli — citty CLI、Ink TUI;web 子命令委托 server(myagent
  • packages/web — React Web UI(Vite)

展开说明(L2/L3):docs/architecture.mddocs/packages.md、各包 packages/*/README.md。完整树与信任规则见 docs/README.md

说明

  • 会话默认标题「新会话」;首条用户消息会自动截断为最多 30 字标题(空白折叠)。
  • 生产 web / server 在存在 packages/web/dist 时托管静态资源,并做 SPA fallback。
  • 请勿在仓库中提交真实 API Key。

About

a cli with tui and web base on @langchian/DeepAgent

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages