How alfredoperez/speckit-companion works
SpecKit Companion is a VS Code spec-driven development workspace: developers choose a workflow, dispatch AI-assisted steps, and follow recorded progress through a structured spec viewer. Its major branches include pipeline customization, inline review, living specs, and sidebar steering documents. The graph follows only relationships stated in the README or visible in supplied excerpts and SOURCE INDEX references; several substantial viewer and living-spec internals were not sampled, so their connections are intentionally limited.
Main entry points: aiProvider.ts AI providers · workflowManager.ts Workflow manager · build-pipeline.py Pipeline build · pipelineBuildCommands.ts Pipeline builder
Components 25
Workflow execution
- VS Code extension
apps/vscode/src/extension.ts - Workflow manager
apps/vscode/src/features/workflows/workflowManager.ts - Pipeline resolution
apps/vscode/src/features/workflows/pipelineResolution.ts - AI providers
apps/vscode/src/ai-providers/aiProvider.ts - Agent manager
apps/vscode/src/features/agents/agentManager.ts - Spec context
apps/vscode/src/features/specs/specContextReader.ts - Integrated terminal
Pipeline customization
- Pipeline builder
apps/vscode/src/features/specs/pipelineBuildCommands.ts - Pipeline graph
apps/vscode/src/features/specs/pipelineGraph.ts - Pipeline contract
apps/vscode/src/protocol/pipeline.ts - Builder interface
apps/vscode/webview/src/pipeline-builder/index.tsx - Pipeline build
apps/speckit-extension/scripts/build-pipeline.py - Command assembly
apps/speckit-extension/scripts/assemble_nodes.py - Workflow configuration
apps/speckit-extension/scripts/companion_config.py
Spec review
- Spec viewer
apps/vscode/src/features/spec-viewer/specViewerProvider.ts - Viewer interface
apps/vscode/webview/src/spec-viewer/App.tsx - Viewer messages
apps/vscode/src/features/spec-viewer/messageHandlers.ts - Inline review
apps/vscode/src/features/spec-viewer/reviewComments.ts - Spec editor
apps/vscode/src/features/spec-editor/specDraftManager.ts
Workspace context
- Living specs
apps/vscode/src/features/living-specs - Specs sidebar
apps/vscode/src/features/specs/specExplorerProvider.ts - Steering documents
apps/vscode/src/features/steering/steeringManager.ts - Project specs
Other components
- Developer
- AI agent
Connections 23
- Developer → VS Code extension: uses
README.md - VS Code extension → Workflow manager: configures
- Workflow manager → AI providers: selects provider
apps/vscode/src/features/workflows/workflowManager.ts - Workflow manager → Pipeline resolution: resolves workflow
apps/vscode/src/features/workflows/pipelineResolution.ts - Pipeline resolution → Spec context: reads context
apps/vscode/src/features/workflows/pipelineResolution.ts - AI providers → Integrated terminal: dispatches prompt
apps/vscode/src/ai-providers/aiProvider.ts - Integrated terminal → AI agent: runs commands
README.md - Agent manager → AI providers: checks provider
apps/vscode/src/features/agents/agentManager.ts - Spec viewer → Viewer interface: renders
- Viewer interface → Viewer messages: sends actions
- Viewer messages → Inline review: handles comments
- Inline review → AI providers: dispatches refinements
- Spec editor → Project specs: writes specs
- Living specs → Spec context: provides context
- Specs sidebar → Project specs: shows status
- Steering documents → AI providers: dispatches prompts
apps/vscode/src/features/steering/steeringManager.ts - Pipeline builder → Pipeline graph: requests graph
apps/vscode/src/features/specs/pipelineGraph.ts - Pipeline builder → Pipeline build: runs build
apps/vscode/src/features/specs/pipelineBuildCommands.ts - Pipeline graph → Pipeline contract: returns structure
apps/vscode/src/features/specs/pipelineGraph.ts - Builder interface → Pipeline contract: uses messages
- Pipeline build → Workflow configuration: loads config
apps/speckit-extension/scripts/build-pipeline.py - Pipeline build → Command assembly: assembles commands
apps/speckit-extension/scripts/build-pipeline.py - Workflow configuration → Project specs: configures workflow