Skip to content

Yumiue/neo-code

 
 

Repository files navigation

中文 | EN

neo-code

一个本地优先的 AI Coding Agent,帮助你理解代码、修改项目、调用工具,并把开发任务接入终端、桌面端和自动化工作流。

Go Version CI Status License Docs Platform

文档 · Issues · Discussions


NeoCode 是什么?

NeoCode 是一个运行在本地开发环境中的 AI Coding Agent。

它可以在工作区中读取项目、理解代码、调用工具、执行命令、管理会话,并通过本地 Gateway 暴露统一的 JSON-RPC / SSE / WebSocket 接口,方便终端、桌面端或第三方客户端接入。

核心闭环:

用户输入(TUI) -> 网关中继(Gateway) -> Agent推理(Runtime) -> 调用工具(Tools) -> 结果回传 -> UI展示


功能特性

  • 本地优先:在你的工作区中运行,面向真实项目上下文。
  • 终端交互:基于 TUI 的对话式 coding agent 体验。
  • 工具调用:支持读取文件、分析项目、执行命令和调用系统工具。
  • 多模型 Provider:支持 OpenAI、Gemini、ModelScope、Qiniu、OpenLL 以及自定义 Provider。
  • 会话持久化:保存和恢复历史会话,减少重复沟通。
  • 记忆能力:保存偏好、项目事实和跨会话上下文。
  • Skills 系统:为不同任务启用专用行为和流程。
  • MCP 接入:通过 MCP stdio server 扩展外部工具能力。
  • Gateway 模式:通过本地 JSON-RPC / SSE / WebSocket 接口连接桌面端、脚本和第三方客户端。

预览

NeoCode TUI 对话视图 NeoCode TUI 执行视图 NeoCode Gateway 交互示例


快速开始

1. 安装

macOS / Linux:

curl -fsSL https://raw.githubusercontent.com/1024XEngineer/neo-code/main/scripts/install.sh | bash

Windows PowerShell:

irm https://raw.githubusercontent.com/1024XEngineer/neo-code/main/scripts/install.ps1 | iex

2. 从源码运行

git clone https://github.com/1024XEngineer/neo-code.git
cd neo-code
go run ./cmd/neocode

3. 配置 API Key

按你使用的 Provider 设置对应环境变量,例如:

export OPENAI_API_KEY="your_key_here"

Windows PowerShell:

$env:OPENAI_API_KEY = "your_key_here"

然后在项目目录中启动:

neocode --workdir /path/to/your/project

4. 常用命令

/help                 查看帮助
/provider             切换 Provider
/model                切换模型
/compact              压缩当前会话上下文
/memo                 查看记忆
/remember <text>      保存记忆
/skills               查看可用 skills
/skill use <id>       启用 skill
/skill off <id>       停用 skill

Gateway / MCP / Skills

详细说明在文档内:


文档

文档站源码位于 www/,本地预览:

cd www
pnpm install
pnpm docs:dev

参与贡献

欢迎通过 Issue、Discussion 或 Pull Request 参与 NeoCode。

建议流程:

  1. 先在 Issue 中描述问题、需求或设计想法。
  2. Fork 仓库并创建功能分支。
  3. 保持改动聚焦,说明动机和影响范围。
  4. 提交前运行基础检查:
gofmt -w ./cmd ./internal
go test ./...
go build ./...

License

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Go 99.2%
  • Vue 0.2%
  • CSS 0.2%
  • TypeScript 0.2%
  • Shell 0.1%
  • PowerShell 0.1%