Docs/Guides/Connect Project

Connect Your Project

Link your codebase to Codmir and unlock AI-powered knowledge base integration for intelligent ticket context and development acceleration.

Why Connect Your Project?

AI-Powered Context

Tickets automatically understand your codebase structure and patterns

Knowledge Base

Auto-generated documentation that stays in sync with your code

Smart Tickets

Ticket details show relevant files, functions, and dependencies

Seamless Integration

Works with your existing workflow and CI/CD pipeline

Prerequisites

Node.js 18+ installed
A Codmir account with a project created
Access to your project's API settings

Install the Codmir Package

Add the codmir CLI/SDK to your project or install globally.

npm install overseer

Tip: Installing globally with npm install -g overseer lets you use the CLI from any directory.

Get Your API Key & Project ID

Retrieve your credentials from the Codmir dashboard.

API Key

Generate from your account settings

Go to API Settings

Project ID

Found in your project settings page

Go to Projects

Configure Environment Variables

Add your credentials to your project's .env file.

# Codmir Configuration
CODMIR_API_KEY=your_api_key_here
CODMIR_PROJECT_ID=proj_xxxxxxxxxxxx

Security Note

Never commit your .env file to version control. Add it to your .gitignore.

Authenticate & Link Your Project

Connect your local project to Codmir.

Option A: Interactive Login (Recommended)

# Authenticate with Codmir (opens browser)
codmir login

Then link your project:

# Link your current directory to a Codmir project
codmir link

The link command will create a .codmir/config.json file in your project root.

Generate Knowledge Base

Analyze your codebase and create the AI knowledge base.

# Generate knowledge base from your codebase
overseer generate

# Or use analyze for full codebase analysis
overseer analyze

What gets analyzed:

📁 File structure & organization

🔗 Dependencies & imports

⚙️ Tech stack detection

📄 Entry points & scripts

📚 README & documentation

🎯 Code patterns & conventions

Generated structure:

your-project/
├── .codmir/
│   ├── config.json          # Project configuration
│   └── knowledge/
│       ├── structure.json   # File tree & organization
│       ├── dependencies.json # Package dependencies
│       ├── patterns.json    # Code patterns detected
│       ├── tech-stack.json  # Technologies used
│       └── context.md       # Human-readable summary
├── .env                     # Your environment variables
└── ... your code

Verify Connection

Confirm everything is working correctly.

# Verify your connection
overseer status

You should see your project name, connection status, and knowledge base sync time.

Automatic Ticket Integration

Once connected, your ticket details will automatically show relevant context from your knowledge base:

Related files and functions based on ticket content
Dependency information for affected modules
Code patterns and conventions to follow
Historical context from similar tickets
AI-powered suggestions for implementation

Keep Knowledge Base Updated

Add to CI/CD Pipeline

Automatically regenerate knowledge base on each deploy.

# .github/workflows/codmir-sync.yml
name: Sync Codmir Knowledge Base

on:
  push:
    branches: [main]

jobs:
  sync:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
      - run: npm install -g overseer
      - run: overseer generate
        env:
          CODMIR_API_KEY: ${{ secrets.CODMIR_API_KEY }}
          CODMIR_PROJECT_ID: ${{ secrets.CODMIR_PROJECT_ID }}

What's Next?

Explore the CLI

Learn all available commands and options.

API Reference

Access knowledge base data programmatically.

🔧 Troubleshooting

Command not found: overseer

Ensure you've installed globally with npm install -g overseer or use npx overseer instead.

Authentication failed

Check that your CODMIR_API_KEY is valid and hasn't expired.

Project not found

Verify your CODMIR_PROJECT_ID matches the project in your dashboard.

your-project/ ├── .codmir/ │ ├── config.json # Project configuration │ └── knowledge/ │ ├── structure.json # File tree & organization │ ├── dependencies.json # Package dependencies │ ├── patterns.json # Code patterns detected │ ├── tech-stack.json # Technologies used │ └── context.md # Human-readable summary ├── .env # Your environment variables └── ... your code

Automatic Ticket Integration

Once connected, your ticket details will automatically show relevant context from your knowledge base:

Related files and functions based on ticket content

Dependency information for affected modules

Code patterns and conventions to follow

Historical context from similar tickets

AI-powered suggestions for implementation

Keep Knowledge Base Updated

Add to CI/CD Pipeline

Automatically regenerate knowledge base on each deploy.

# .github/workflows/codmir-sync.yml
name: Sync Codmir Knowledge Base

on:
  push:
    branches: [main]

jobs:
  sync:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
      - run: npm install -g overseer
      - run: overseer generate
        env:
          CODMIR_API_KEY: ${{ secrets.CODMIR_API_KEY }}
          CODMIR_PROJECT_ID: ${{ secrets.CODMIR_PROJECT_ID }}