Skip to content

cli-quickstart.md

Latest commit

 

History

History
150 lines (102 loc) · 3.49 KB

cli-quickstart.md

File metadata and controls

150 lines (102 loc) · 3.49 KB

CLI Quickstart

SourceBridge.ai is a requirement-aware code comprehension platform that helps you trace requirements to code, run structured reviews, and understand codebases.

Installation

Option 1: One-line installer (recommended for the CLI)

curl -fsSL https://<your-server>/install.sh | sh -s -- --server https://<your-server>

Installs sourcebridge to ~/.local/bin (no sudo) and authenticates against your server in one step. See Installation for the trust model and alternate paths.

Option 2: Docker Compose (server)

git clone https://github.com/sourcebridge/sourcebridge.git
cd sourcebridge
docker compose up -d

This starts the API server, web UI, and all dependencies.

Option 3: Homebrew (macOS / Linux)

brew install sourcebridge-ai/tap/sourcebridge

Option 4: From Source (manual)

go build -o bin/sourcebridge ./cmd/sourcebridge

First Steps

1. Start the Server

sourcebridge serve

The API server starts at http://localhost:8080.

2. Index a Repository

sourcebridge index /path/to/your/repo

SourceBridge.ai parses source files using tree-sitter and builds a graph of modules, files, and symbols.

After indexing succeeds, the CLI prints a one-liner suggesting the next step:

Indexed 1,247 symbols. Use with Claude Code:
  sourcebridge setup claude --repo-id abc123

3. Connect Claude Code (optional)

If you use Claude Code, run the suggested command from your repository's working directory:

cd /path/to/your/repo
sourcebridge setup claude --repo-id abc123

This writes .claude/CLAUDE.md with a per-subsystem reference card, registers SourceBridge's MCP server in .mcp.json, and patches .gitignore. Claude Code will now have instant context about your codebase's subsystem boundaries before you start a refactor. See Using SourceBridge from an AI client (MCP) for other clients (Codex, Cursor, Claude Desktop).

4. Import Requirements

Create a requirements file in markdown format:

# Requirements

## REQ-001: User Authentication
- Category: security
- Priority: high
Users must authenticate before accessing the system.

## REQ-002: Data Validation
- Category: data
- Priority: high
All input data must be validated before processing.

Import it:

sourcebridge import /path/to/requirements.md

5. Trace Requirements to Code

sourcebridge trace REQ-001

This shows which code symbols are linked to the requirement, with confidence scores.

6. Run a Code Review

sourcebridge review /path/to/repo --template security

Available templates: security, solid, performance, reliability, maintainability.

7. Ask Questions About Code

sourcebridge ask "What does the processPayment function do?"

Web UI

Open http://localhost:3300 to access the web dashboard with:

  • Repository browser
  • Requirements list with linked code
  • Traceability matrix visualization
  • Coverage charts

VS Code Extension

Install the SourceBridge.ai extension from the VS Code Marketplace for:

  • Requirement IDs displayed above functions (CodeLens)
  • Hover cards with requirement links
  • Gutter decorations showing requirement coverage
  • Sidebar panels for requirements and discussions

Next Steps