Skip to content

yuanze-dev/opencortex

Repository files navigation

OpenCortex

Open Knowledge for Your Cortex - 开放的团队大脑

AI-native 团队知识中枢 - 自动从 Linear、GitHub、飞书中捕获、结构化和维护团队知识


📖 项目简介

OpenCortex 是一个面向 10-50 人小型技术团队的知识管理系统,核心价值是 "AI 写,人审核"

  • 自动收集:从 Linear、GitHub 自动拉取数据
  • AI 提取:使用 LLM 提取决策、技术方案、调研发现
  • 零配置:接入数据源后自动工作,无需手动建知识库
  • 即时查询:支持自然语言搜索

🚀 快速开始

1. 环境准备

# 克隆项目
git clone https://github.com/your-username/opencortex.git
cd opencortex

# 创建虚拟环境
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate

# 安装依赖
pip install -r requirements.txt

2. 配置环境变量

# 复制示例配置
cp .env.example .env

# 编辑 .env 文件,填入你的 API Keys
# LINEAR_API_KEY=your_key_here
# GITHUB_TOKEN=your_token_here
# OPENAI_API_KEY=your_key_here

3. 初始化数据库

python scripts/init_db.py

4. 运行测试

python scripts/linear_connector.py
python scripts/github_connector.py
python scripts/llm_extractor.py

📚 文档


🏗️ 项目结构

OpenCortex/
├── docs/                   # 技术文档
│   ├── README.md          # 文档导航
│   ├── 01-快速入门.md
│   ├── 02-技术架构.md
│   ├── 03-Linear接入方案.md
│   ├── 04-GitHub接入方案.md
│   ├── 05-LLM提取方案.md
│   ├── 06-数据库设计.md
│   └── 07-实施计划.md
├── scripts/               # 脚本文件
│   ├── init_db.py        # 初始化数据库
│   ├── linear_connector.py
│   ├── github_connector.py
│   ├── llm_extractor.py
│   └── database.py
├── data/                  # 数据文件(不提交到 Git)
├── tests/                 # 测试文件
├── MEMORY.md             # 项目记忆
├── CONSTITUTION.md       # 项目宪法
├── key.md                # 敏感信息(不提交到 Git)
├── requirements.txt      # Python 依赖
└── README.md             # 本文件

🎯 开发阶段

阶段 目标 状态
Phase 0 静默收集 ✅ 已完成
Phase 1 查询界面 ⏳ 待开始
Phase 2 主动推送 ⏳ 待开始
Phase 3 产品化 ⏳ 待开始

🤝 贡献指南

  1. 开始开发前,阅读 MEMORY.md 了解项目历史
  2. 阅读 CONSTITUTION.md 了解开发规范
  3. 完成开发后,更新 MEMORY.md 记录变更
  4. 提交 PR 前确保通过测试

📞 联系方式

项目负责人: 晓力
问题反馈: [待补充]


📄 许可证

[待定]


最后更新: 2026-03-10
版本: v0.2.0

About

OpenCortex - Open Knowledge for Your Cortex

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages