Smart-Codebase

English | 简体中文

Turn your OpenCode into a senior project expert that learns and grows with every task.

---

🔥 The Pain Point

Every time you start a new session, AI starts from scratch. It doesn’t remember:

• Why you chose that architecture?
• What gotchas exist in your codebase?
• What patterns your team follows?
• What you learned from debugging that nasty bug?

You explain the same things over and over.

✨ The Solution

Smart-Codebase gives your AI permanent memory through SKILL files. It uses an AI agent to autonomously capture knowledge from your conversations and project files.

graph TB
    Start([Session Work])
    Init[sc-init command]
    Update[sc-update command]
    InitAgent[AI Scans Source Code]
    UpdateAgent[AI Analyzes Session]
    SkillFile[.opencode/skills/project/SKILL.mdOpenCode Auto-Discovery]
    RefFiles[.opencode/skills/project/reference/*.mdDeep Dive Docs]
    NewSession([New Session Starts])
    Injector[Context Injector]
    
    Start --> Init
    Start --> Update
    Init --> InitAgent
    Update --> UpdateAgent
    InitAgent -->|writes| SkillFile
    InitAgent -->|writes| RefFiles
    UpdateAgent -->|updates| SkillFile
    UpdateAgent -->|updates| RefFiles
    
    NewSession --> Injector
    Injector -->|inject hint| SkillFile

---

📖 Table of Contents

• ⚙️ How It Works
• 📦 Installation
• ⚡ Commands
• ⚙️ Configuration
• 📁 File Structure
• 🛠️ Development

---

⚙️ How It Works

1. You work normally - Edit files, debug issues, and make architectural decisions.
2. First time setup - Run /sc-init once to scan your source code and generate comprehensive SKILL files.
3. Ongoing capture - When you reach a milestone, run /sc-update to extract knowledge from the current session.
4. AI Agent analyzes - A child AI session examines your conversation or project code to understand what changed and why.
5. Knowledge distilled - The agent autonomously writes or updates SKILL files in standard OpenCode format.
6. Next session starts - New sessions auto-discover your project SKILLs, giving the AI immediate context.

Manual control means you decide exactly when to preserve knowledge. The AI agent handles the heavy lifting of writing documentation.

---

📦 Installation

Navigate to your ~/.config/opencode directory:

# Using bun
bun add smart-codebase

# Or using npm
npm install smart-codebase

Add to your opencode.json:

{
  "plugin": ["smart-codebase"]
}

---

⚡ Commands

---

⚙️ Configuration

Create ~/.config/opencode/smart-codebase.json (or .jsonc) to customize:

{
  "enabled": true,
  "extractionModel": "openai/gpt-4o",
  "extractionMaxTokens": 16000
}

---

📁 File Structure

Knowledge is stored in your project directory using the standard OpenCode SKILL format:

project/
└── .opencode/
    └── skills/
        └── /
            ├── SKILL.md          # Main project skill and index
            └── reference/        # Detailed documentation files
                ├── architecture.md
                └── api-patterns.md

---

🛠️ Development

# Install dependencies
bun install

# Build the plugin
bun run build

# Run type checks
bun run typecheck

# Run tests
bun test

---

📄 License

Apache-2.0