Using VS Code Copilot with Igniter.js
GitHub Copilot is one of the most popular AI code assistants, deeply integrated into Visual Studio Code. To make it an expert on your Igniter.js project, you can provide it with persistent context through custom instructions.
Method 1: Training Copilot on the Igniter.js Framework
This method gives Copilot a deep, foundational understanding of the entire Igniter.js framework by pointing it to our official, comprehensive documentation file. This is the recommended approach for any Igniter.js project.
Step 1: Create a Copilot Directory
In the root of your project, create a new directory for Copilot's instructions:
mkdir -p .github/copilot
Step 2: Create the Instructions File
Inside the new directory, create a Markdown file named instructions.md.
Step 3: Add the Instruction Content
Open .github/copilot/instructions.md and paste the following content. This rule instructs Copilot to use our llms.txt—a single file containing our entire documentation—as its primary source of knowledge for all chat interactions.
# Igniter.js Framework Expert
You are an expert developer specializing in the Igniter.js framework. Your primary source of knowledge for all framework-related questions and code generation is the official documentation, which can be found in its entirety at: https://igniterjs.com/llms.txt.
Always adhere to the patterns and best practices described in that document. Before answering any question, consult this source to ensure accuracy.
With this file in place, Copilot Chat will automatically use this context in every conversation, leading to highly accurate and relevant assistance.
Method 2: Use an Official Igniter.js Template (The Easy Way)
The easiest way to work with Copilot is by starting your project with one of our official templates. These templates come pre-configured with detailed AGENT.md files that are compatible with Copilot's context mechanisms.
When you open an Igniter.js template project in VS Code, Copilot can use the provided AGENT.md file as a project-specific instruction set with no additional setup required.
Recommended Project Templates
Our templates come ready with everything you need to start building, including the AI instructions that Copilot will automatically use.
