Installation
How to install and configure the AI SDLC Kit in your project.
Prerequisites
Before you begin, make sure you have:
- VS Code (latest version recommended)
- GitHub Copilot subscription with agent mode enabled
- GitHub Copilot Chat extension installed and signed in
- Agent mode enabled in VS Code settings (
"github.copilot.chat.agent.enabled": true)
Option A β Copy into your project (recommended)
This is the simplest approach. The kit travels with your repository.
- Copy the
.github/agents/folder to your project's.github/agents/ - Copy the
.github/prompts/folder to your project's.github/prompts/ - Copy the
.github/templates/folder to your project's.github/templates/ - Add the following to your project's
.vscode/settings.json:
{
"chat.agentFilesLocations": { ".github/agents": true },
"chat.promptFilesLocations": { ".github/prompts": true }
}
- Create the
doc-specs/folder at the root of your project:
mkdir doc-specs
Option B β Point VS Code to the kit folder or an unpacked bundle
If you prefer to keep the kit as a shared external folder (e.g., used across multiple projects), add the paths to your .vscode/settings.json:
{
"chat.agentFilesLocations": { "./ai-sdlc-kit/.github/agents": true },
"chat.promptFilesLocations": { "./ai-sdlc-kit/.github/prompts": true }
}
Bash-first installation (Option B)
To avoid editing settings.json manually, run the installer from the consumer project root so it updates that project's .vscode/settings.json:
bash /path/to/ai-sdlc-kit/scripts/install.sh /path/to/ai-sdlc-kit
For example:
cd /path/to/your-project
bash /path/to/ai-sdlc-kit/scripts/install.sh /path/to/ai-sdlc-kit
If you copied the kit into the consumer repo as ./ai-sdlc-kit, you can still run:
cd /path/to/your-project
bash ./ai-sdlc-kit/scripts/install.sh ./ai-sdlc-kit
The script detects an existing settings.json and merges the required entries without overwriting any other configuration. If the file does not exist, it is created.
Offline and governed environments
You do not need a second documentation source to run the kit. The operational guidance now lives directly in the official docs under:
To generate an approved offline artifact for internal distribution:
bash scripts/package-bundle.sh
This produces a versioned bundle directory, a .tar.gz archive, and a sha256 file under dist/.
Verify discovery
After installation, open the GitHub Copilot Chat panel and type / in the input field. You should see the kit prompts listed (e.g., /discovery-refine, /task-implement, etc.).
Open the agent selector and confirm that the kit agents appear (e.g., π§ Discovery, ποΈ Architect, π οΈ Implementer, etc.).
If prompts or agents are not discovered:
- Confirm the paths in
.vscode/settings.jsonare correct and relative to the workspace root. - Reload VS Code (
Ctrl+Shift+Pβ Developer: Reload Window). - Check that the files in
.github/agents/have the.agent.mdextension and valid YAML frontmatter.
Project folder structure after installation
your-project/
βββ .github/
β βββ agents/ β AI SDLC Kit agents
β βββ prompts/ β AI SDLC Kit prompts
β βββ templates/ β AI SDLC Kit templates
βββ .vscode/
β βββ settings.json β agent/prompt discovery config
βββ doc-specs/ β all spec artefacts go here
β βββ idea.txt β (Flow A) or
β βββ task.txt β (Flow B)
βββ ...
The doc-specs/ folder is the working directory for all generated artefacts β specs, PRDs, epics, decisions logs, and context memory. It should be committed to version control.