Skip to content

Quick Start

Get up and running with project standards in 5 minutes.

Option A: One-line installer

Terminal window
curl -fsSL https://raw.githubusercontent.com/c65llc/coding-standards/main/install.sh | bash

Option B: Git submodule (recommended for teams)

Terminal window
git submodule add https://github.com/c65llc/coding-standards.git .standards

Option C: Clone directly

Terminal window
git clone https://github.com/c65llc/coding-standards.git .standards
Terminal window
.standards/scripts/setup.sh

This automatically configures all supported AI agents:

  • .cursorrules for Cursor AI
  • .github/copilot-instructions.md for GitHub Copilot
  • .aiderrc for Aider / Claude Code
  • .codexrc for OpenAI Codex
  • .gemini/GEMINI.md and .gemini/settings.json for Gemini CLI

Quit and reopen your editor (Cursor, VS Code, etc.) to load the new configuration.

Terminal window
# Initial setup
make setup
# Sync to latest standards
make sync-standards
# Check if standards are current
make check-standards
# Update the standards submodule
make update-standards
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
└── ...

Team members sync by running:

Terminal window
make sync-standards
# or
.standards/scripts/sync-standards.sh

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?

Terminal window
make sync-standards