josiadmin/awesome-copilot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Finalize refined installation process with updated documentation and CLI improvements

Browse Source 
Co-authored-by: AstroSteveo <34114851+AstroSteveo@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot] 2025-09-20 22:02:52 +00:00
parent 61e056c8e0
commit 0585489dca
2 changed files with 29 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -114,6 +114,33 @@ We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.
## 🌟 Getting Started ## 🌟 Getting Started
### 🔧 CLI Installation (Recommended)
Install awesome-copilot CLI for streamlined project setup:
```bash
# Install globally via npm
npm install -g awesome-copilot
# Or run without installing
npx awesome-copilot init
```
**Quick Setup:**
1. Navigate to your project directory
2. Run `awesome-copilot init` to create configuration and VS Code setup
3. Edit `awesome-copilot.config.yml` to enable desired items
4. Run `awesome-copilot apply` to copy files to your project
5. Start using enhanced GitHub Copilot!
✨ **Benefits:**
- Clean project setup with automatic VS Code configuration
- Files organized in `.awesome-copilot/` directory
- Automatic `.gitignore` management
- Easy updates by re-running `apply` command
### 📖 Manual Installation
1. **Browse the Collections**: Check out our comprehensive lists of [prompts](README.prompts.md), [instructions](README.instructions.md), [chat modes](README.chatmodes.md), and [collections](README.collections.md). 1. **Browse the Collections**: Check out our comprehensive lists of [prompts](README.prompts.md), [instructions](README.instructions.md), [chat modes](README.chatmodes.md), and [collections](README.collections.md).
2. **Add to your editor**: Click the "Install" button to install to VS Code, or copy the file contents for other editors. 2. **Add to your editor**: Click the "Install" button to install to VS Code, or copy the file contents for other editors.
3. **Start Using**: Copy prompts to use with `/` commands, let instructions enhance your coding experience, or activate chat modes for specialized assistance. 3. **Start Using**: Copy prompts to use with `/` commands, let instructions enhance your coding experience, or activate chat modes for specialized assistance.

4
generate-config.js
View File

@ -59,7 +59,7 @@ function generateConfig(outputPath = "awesome-copilot.config.yml") {
# Set items to 'true' to include them in your project # Set items to 'true' to include them in your project
# Set items to 'false' to exclude them # Set items to 'false' to exclude them
# #
# After configuring, run: node apply-config.js # After configuring, run: awesome-copilot apply
# #
`; `;
@ -71,7 +71,7 @@ function generateConfig(outputPath = "awesome-copilot.config.yml") {
console.log(`Found ${prompts.length} prompts, ${instructions.length} instructions, ${chatmodes.length} chat modes, ${collections.length} collections`); console.log(`Found ${prompts.length} prompts, ${instructions.length} instructions, ${chatmodes.length} chat modes, ${collections.length} collections`);
console.log("\nNext steps:"); console.log("\nNext steps:");
console.log("1. Edit the configuration file to enable desired items"); console.log("1. Edit the configuration file to enable desired items");
console.log("2. Run: node apply-config.js to apply the configuration"); console.log("2. Run: awesome-copilot apply to apply the configuration");
} }
/** /**