Getting Started

Install and configure Awesome AGV in minutes.

Table of contents
  1. Prerequisites
  2. Installation
    1. Option 1: Quick Install (Recommended)
    2. Option 2: Copy the .agents folder
    3. Option 3: Git submodule
  3. Configuration
    1. Antigravity / Roo Code / Claude Code
    2. Gemini CLI
    3. Other AI Coding Assistants
  4. Verifying Installation
  5. What Happens Next?
  6. Quick Tour
    1. Try the Feature Workflow
    2. Try a Quick Fix
    3. Try an Audit
  7. Next Steps

Prerequisites

  • An AI Coding Assistant (Antigravity, Roo Code, Claude Code, Cline, etc.)
  • A project where you want to enforce high standards

Installation

npx awesome-agv

This launches an interactive installer where you choose your installation mode:

Mode Description
πŸš€ Default Install everything β€” the full arsenal (recommended)
🎯 Curated Pick your languages & frameworks. Core rules and skills always included.
βš™οΈ Advanced Full granular control over every component.

In Curated and Advanced modes, the installer auto-detects your project’s tech stack from files like go.mod, Cargo.toml, tsconfig.json, pubspec.yaml, etc. and pre-selects matching stacks.

CLI Flags:

Flag Description
--stacks <list> Comma-separated stacks to include (additive with existing config)
--all Install everything (equivalent to Default mode)
--force, -f Replace existing .agents/ β€” re-prompts from scratch
--help, -h Show help

Examples:

# Interactive β€” choose your mode
npx awesome-agv

# Non-interactive: specific stacks, core always included
npx awesome-agv --stacks go,python

# Add React to existing installation (additive)
npx awesome-agv --stacks react

# Full install, no prompts
npx awesome-agv --all --force

# CI/CD: specific stacks, no prompts
npx awesome-agv --stacks typescript,vue --force

Option 2: Copy the .agents folder

Clone this repository or copy the .agents folder into the root of your project:

# Clone the repo
git clone https://github.com/irahardianto/awesome-agv.git

# Copy the .agent folder into your project
cp -r awesome-agv/.agents /path/to/your-project/

Option 3: Git submodule

Add as a submodule for easy updates:

cd your-project
git submodule add https://github.com/irahardianto/awesome-agv.git .awesome-agv
ln -s .awesome-agv/.agents .agents

Configuration

Antigravity / Roo Code / Claude Code

These tools read from the .agents directory by default. No additional configuration is needed β€” just drop the folder in and start coding.

Gemini CLI

Ingest the rules as custom system prompt context. You can reference individual rule files:

# Point Gemini CLI to the rules directory
# Refer to Gemini CLI documentation for custom instructions

Other AI Coding Assistants

For any tool that supports custom system prompts or context loading:

  1. Load all files from .agents/rules/ into the system prompt
  2. Optionally load .agents/skills/ for specialized capabilities
  3. Optionally load .agents/workflows/ for structured development processes

Verifying Installation

After installation, test that your agent is picking up the rules:

  1. Ask your agent: β€œWhat rules are you following?”
  2. Check that it mentions the Rugged Software Constitution or Security Mandate
  3. Try writing code and watch for:
    • Automatic input validation on API handlers
    • Structured logging at operation entry points
    • Interface-based I/O abstraction

What Happens Next?

Once installed, the setup activates automatically:

Component Activation Effect
Mandates Always loaded Agent always validates code, adds logging, follows security rules
Principles Contextual Agent applies database rules when writing queries, CI/CD rules when editing pipelines, etc.
Skills On demand Agent uses debugging protocol when stuck, guardrails before/after writing code
Workflows Slash commands Use /workflow-solo for features, /bugfix for bugs, /audit for reviews

Everything is modular. Rules and skills work independently β€” you don’t need workflows to benefit from them. Use only the rules you want, build your own workflows, or skip workflows entirely. The setup is a toolkit, not a framework.

Quick Tour

Try the Feature Workflow

Start building a feature with the structured workflow:

/workflow-solo

This chains the full development lifecycle:

  1. Research β€” understand context, search documentation
  2. Implement β€” TDD cycle (Red β†’ Green β†’ Refactor)
  3. Integrate β€” test with real infrastructure (Testcontainers)
  4. Verify β€” full lint, test, and build validation
  5. Ship β€” git commit with conventional format

Try a Quick Fix

For a small bug fix:

/bugfix

This skips research and integration, going straight to: Diagnose β†’ Fix + Test β†’ Verify β†’ Ship.

Try an Audit

Review existing code quality:

/audit

This produces a structured findings report graded by severity (Critical β†’ Major β†’ Minor β†’ Nit).

Next Steps


Back to top

Built with ❀️ for the Developer Community. Distributed under the MIT License.

This site uses Just the Docs, a documentation theme for Jekyll.