- 🌟 Features
- 💡 Why Use psst-ai?
- 📦 Setup
- 🚀 Usage
- 📄 Generated Instructions Format
- 🔧 How to Use the Generated Instructions
- 🧰 Editors Integration
- Command Options
- 🧩 What's Detected?
Automatically extract coding conventions and preferences from your project and generate tailored instructions for AI code assistants like GitHub Copilot, Cursor, and more.
- 🔍 Zero Configuration: Just run the CLI and it automatically detects your project's setup
- 📦 Detects Package Managers: Identifies whether you use npm, yarn, or pnpm
- 🔢 Finds Node Versions: Extracts Node.js version requirements from your .nvmrc file
- 🧹 Recognizes Linting Tools: Detects ESLint, XO, and other linting configurations
- 🧪 Identifies Testing Frameworks: Recognizes Jest, Vitest, and other testing setups
- 📝 Generates Instructions: Creates a markdown file with AI-ready instructions
- And more...
- No More Repetition: Stop typing the same instructions every time you chat with AI
- Consistency: Ensure all team members give the same instructions to AI assistants
- Time Saver: Automatically detect project conventions without manual effort
- Project Onboarding: Help new team members understand coding standards through AI
- Lightweight & Fast: Focused CLI design means quick installation and execution
- -f, --file <path> - Load file with sections to update
That's it! The tool will:
- Scan your project files and configuration
- Detect coding conventions and preferences
- Print the AI-ready instructions directly to your terminal
After running the tool, you'll see instructions printed to your terminal based on your project's conventions:
- Copy the output from your terminal
- Paste into your AI assistant's instructions panel:
- GitHub Copilot: Chat instructions
- Cursor: Workspace instructions
- VS Code AI Assistant: Custom instructions
- Other AI coding tools: Custom prompts section
Insert the start and end tags <!-- PSST-AI-INSTRUCTIONS-START --> and <!-- PSST-AI-INSTRUCTIONS-END --> in your instruction file, and psst-ai will replace the content between these tags with the generated instructions.
For VS Code's GitHub Copilot Chat, place your instructions file in .github/copilot-instructions.md and run:
For Cursor AI, place your instructions file in .cursor/rules/ai-instructions.mdc and run:
For Windsurf AI, place your instructions file in .windsurf/rules/ai-instructions.md and run:
- -o, --output <path> - Save output to a file
- -q, --quiet - Suppress console output
- -v, --verbose - Show verbose output
- --no-header - Flatten output without category headers
Currently, psst-ai can detect:
Package Managers | npm, yarn, pnpm |
Node.js Versions | From .nvmrc file |
Linting Tools | ESLint, XO, StandardJS |
Testing Frameworks | Jest, Vitest, Mocha |