KIRINCODE.md 1.2 KB


name: KirinCode scope: enterprise

version: "0.1"

KirinCode — 开邻Claw

基于 OpenCode 的 AI 编码代理,具备自动记忆和技能学习能力。 Built on OpenCode (https://github.com/anomalyco/opencode) under MIT License.

项目结构

  • packages/kirincode/ — 核心 CLI + TUI 引擎
  • packages/kirincode-core/ — 自动记忆 + 技能系统插件
  • packages/desktop/ — Electron 桌面应用
  • packages/tui/ — 终端 UI 框架
  • packages/core/ — 核心共享库

构建命令

bun install
bun run --cwd packages/kirincode build

测试命令

bun run --cwd packages/kirincode test
bun run --cwd packages/kirincode typecheck

代码风格

  • TypeScript strict mode
  • Effect-TS 函数式编程范式
  • 使用 Bun 原生 API 优先
  • 避免 try/catch,使用 Effect 的 Either/Option
  • 函数式数组方法优于 for 循环

命名约定

  • 文件名: kebab-case
  • 变量/函数: camelCase
  • 类型/接口: PascalCase
  • Effect Service: Context.Service<Service, Interface>()("@kirincode/...")

上游同步

主分支跟踪 OpenCode dev 分支。 通过 rebase 保持同步,定制化代码集中在:

  • packages/kirincode-core/ (插件)
  • 品牌主题文件
  • 配置文件