Welcome to your system pilot documentation!¶
Your project has 5000 requirements. A change affects 5 of them. Find those 5.
syspilot is a requirements engineering toolkit that gives AI agents focused context — not your entire codebase, just the parts that matter. It uses sphinx-needs traceability links to navigate from a User Story down to exactly the affected Requirements and Design Specs.
The result? O(affected), not O(total). That’s what makes it scale.
Getting Started¶
1. Download the setup agent into your project:
# Linux / Mac
mkdir -p .github/agents && curl -fsSL \
"https://raw.githubusercontent.com/enthali/syspilot/main/syspilot/agents/syspilot.setup.agent.md" \
-o .github/agents/syspilot.setup.agent.md
# Windows (PowerShell)
New-Item -ItemType Directory -Force -Path .github/agents | Out-Null
Invoke-WebRequest `
-Uri "https://raw.githubusercontent.com/enthali/syspilot/main/syspilot/agents/syspilot.setup.agent.md" `
-OutFile ".github/agents/syspilot.setup.agent.md"
2. Open VS Code Copilot Chat and type @syspilot.setup — the agent does the rest.
That’s it. Dependencies, config, validation — all handled automatically.
Prerequisites: VS Code + GitHub Copilot, Python 3.10+
How It Works¶
Three levels, connected by traceability links:
User Story (WHY) ──links──▶ Requirements (WHAT) ──links──▶ Design Specs (HOW)
When you request a change, syspilot follows these links to find only the affected elements — then hands that focused context to the AI agent. No guessing, no scanning.
Your AI Team¶
Nine agents, each with a clear job:
Agent |
What it does |
|---|---|
|
Analyzes a change request, creates a Change Document listing all affected specs |
|
Executes approved changes with full traceability |
|
Checks implementation against the Change Document |
|
Keeps project memory (copilot-instructions.md) current |
|
Finds gaps and redundancies in your specs (one level at a time) |
|
Traces one item through all levels — up and down |
|
Manages versioning, release notes, and GitHub publishing |
|
Installs or updates syspilot in your project |
The typical workflow: change → implement → verify → memory. Done.
FAQ¶
- Do I need to know reStructuredText?
Not really. The agents write the RST for you. But it helps to understand the basics — it’s just text with some directives.
- Can I use this with an existing project?
Yes.
@syspilot.setupcan adopt an existingdocs/folder. You can also start with an empty project and grow from there.- What about Markdown?
syspilot uses myst-parser so you can mix Markdown and RST. The specs themselves use RST (because sphinx-needs requires it), but your prose documentation can be Markdown.
- Is this only for automotive / A-SPICE?
No. The spec hierarchy (User Stories → Requirements → Design) is universal. The A-SPICE alignment is optional and documented under Process Documentation.
- How is this different from just using Copilot?
Copilot is great at writing code. But it doesn’t know which of your 500 requirements are affected by a change. syspilot solves that navigation problem — then Copilot does what it does best.
Specification Reference¶
syspilot Family
syspilot Instance (Dogfooding)