Quick Start
Quick Start
Section titled “Quick Start”Get up and running with project standards in 5 minutes.
Step 1: Install Standards
Section titled “Step 1: Install Standards”Option A: One-line installer
curl -fsSL https://raw.githubusercontent.com/c65llc/coding-standards/main/install.sh | bashOption B: Git submodule (recommended for teams)
git submodule add https://github.com/c65llc/coding-standards.git .standardsOption C: Clone directly
git clone https://github.com/c65llc/coding-standards.git .standardsStep 2: Run Setup
Section titled “Step 2: Run Setup”.standards/scripts/setup.shThis automatically configures all supported AI agents:
.cursorrulesfor Cursor AI.github/copilot-instructions.mdfor GitHub Copilot.aiderrcfor Aider / Claude Code.codexrcfor OpenAI Codex.gemini/GEMINI.mdand.gemini/settings.jsonfor Gemini CLI
Step 3: Restart Your Editor
Section titled “Step 3: Restart Your Editor”Quit and reopen your editor (Cursor, VS Code, etc.) to load the new configuration.
Common Commands
Section titled “Common Commands”# Initial setupmake setup
# Sync to latest standardsmake sync-standards
# Check if standards are currentmake check-standards
# Update the standards submodulemake update-standardsProject Layout After Setup
Section titled “Project Layout After Setup”your-project/├── .cursorrules # Cursor AI configuration├── .github/│ └── copilot-instructions.md # GitHub Copilot config├── .aiderrc # Aider / Claude Code config├── .codexrc # OpenAI Codex config├── .gemini/│ ├── GEMINI.md # Gemini CLI context│ └── settings.json # Gemini CLI settings├── .standards/ # Standards submodule│ ├── standards/ # Standards documents│ ├── scripts/ # Automation scripts│ └── docs/ # Documentation└── ...Keeping Standards Up to Date
Section titled “Keeping Standards Up to Date”Team members sync by running:
make sync-standards# or.standards/scripts/sync-standards.shTroubleshooting
Section titled “Troubleshooting”Editor not using standards?
- Make sure
.cursorrules(or the relevant config file) is in your project root. - Restart your editor completely.
Standards out of date?
make sync-standardsNext Steps
Section titled “Next Steps”- Installation Guide for detailed setup options
- Multi-Agent Setup for configuring specific AI agents
- Customization Guide to adapt standards for your team