-
-
Notifications
You must be signed in to change notification settings - Fork 11.9k
docs: add Antigravity setup and usage guide #552
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
affaan-m
merged 5 commits into
affaan-m:main
from
vazidmansuri005:docs/antigravity-setup-guide
Mar 20, 2026
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
1707ac7
docs: add Antigravity setup and usage guide
vazidmansuri005 925ee9a
fix: address review feedback on Antigravity guide
vazidmansuri005 1688db9
fix: clarify .agents/ vs .agent/ naming and fix Cursor comparison
vazidmansuri005 958c6ef
fix: correct installer behavior claims and command style
vazidmansuri005 788be0f
fix: add missing agents/ step to contributor workflow
vazidmansuri005 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,156 @@ | ||
| # Antigravity Setup and Usage Guide | ||
|
|
||
| Google's [Antigravity](https://antigravity.dev) is an AI coding IDE that uses a `.agent/` directory convention for configuration. ECC provides first-class support for Antigravity through its selective install system. | ||
|
|
||
| ## Quick Start | ||
|
|
||
| ```bash | ||
| # Install ECC with Antigravity target | ||
| ./install.sh --target antigravity typescript | ||
|
|
||
| # Or with multiple language modules | ||
| ./install.sh --target antigravity typescript python go | ||
| ``` | ||
|
|
||
| This installs ECC components into your project's `.agent/` directory, ready for Antigravity to pick up. | ||
|
|
||
| ## How the Install Mapping Works | ||
|
|
||
| ECC remaps its component structure to match Antigravity's expected layout: | ||
|
|
||
| | ECC Source | Antigravity Destination | What It Contains | | ||
| |------------|------------------------|------------------| | ||
| | `rules/` | `.agent/rules/` | Language rules and coding standards (flattened) | | ||
| | `commands/` | `.agent/workflows/` | Slash commands become Antigravity workflows | | ||
| | `agents/` | `.agent/skills/` | Agent definitions become Antigravity skills | | ||
|
|
||
| > **Note on `.agents/` vs `.agent/` vs `agents/`**: The installer only handles three source paths explicitly: `rules` → `.agent/rules/`, `commands` → `.agent/workflows/`, and `agents` (no dot prefix) → `.agent/skills/`. The dot-prefixed `.agents/` directory in the ECC repo is a **static layout** for Codex/Antigravity skill definitions and `openai.yaml` configs — it is not directly mapped by the installer. Any `.agents/` path falls through to the default scaffold operation. If you want `.agents/skills/` content available in the Antigravity runtime, you must manually copy it to `.agent/skills/`. | ||
|
|
||
| ### Key Differences from Claude Code | ||
|
|
||
| - **Rules are flattened**: Claude Code nests rules under subdirectories (`rules/common/`, `rules/typescript/`). Antigravity expects a flat `rules/` directory — the installer handles this automatically. | ||
| - **Commands become workflows**: ECC's `/command` files land in `.agent/workflows/`, which is Antigravity's equivalent of slash commands. | ||
| - **Agents become skills**: ECC agent definitions map to `.agent/skills/`, where Antigravity looks for skill configurations. | ||
|
|
||
| ## Directory Structure After Install | ||
|
|
||
| ``` | ||
| your-project/ | ||
| ├── .agent/ | ||
| │ ├── rules/ | ||
| │ │ ├── coding-standards.md | ||
| │ │ ├── testing.md | ||
| │ │ ├── security.md | ||
| │ │ └── typescript.md # language-specific rules | ||
| │ ├── workflows/ | ||
| │ │ ├── plan.md | ||
| │ │ ├── code-review.md | ||
| │ │ ├── tdd.md | ||
| │ │ └── ... | ||
| │ ├── skills/ | ||
| │ │ ├── planner.md | ||
| │ │ ├── code-reviewer.md | ||
| │ │ ├── tdd-guide.md | ||
| │ │ └── ... | ||
| │ └── ecc-install-state.json # tracks what ECC installed | ||
| ``` | ||
|
|
||
| ## The `openai.yaml` Agent Config | ||
|
|
||
| Each skill directory under `.agents/skills/` contains an `agents/openai.yaml` file at the path `.agents/skills/<skill-name>/agents/openai.yaml` that configures the skill for Antigravity: | ||
|
|
||
| ```yaml | ||
| interface: | ||
| display_name: "API Design" | ||
| short_description: "REST API design patterns and best practices" | ||
| brand_color: "#F97316" | ||
| default_prompt: "Design REST API: resources, status codes, pagination" | ||
| policy: | ||
| allow_implicit_invocation: true | ||
| ``` | ||
|
|
||
| | Field | Purpose | | ||
| |-------|---------| | ||
| | `display_name` | Human-readable name shown in Antigravity's UI | | ||
| | `short_description` | Brief description of what the skill does | | ||
| | `brand_color` | Hex color for the skill's visual badge | | ||
| | `default_prompt` | Suggested prompt when the skill is invoked manually | | ||
| | `allow_implicit_invocation` | When `true`, Antigravity can activate the skill automatically based on context | | ||
|
|
||
| ## Managing Your Installation | ||
|
|
||
| ### Check What's Installed | ||
|
|
||
| ```bash | ||
| node scripts/list-installed.js --target antigravity | ||
| ``` | ||
|
|
||
| ### Repair a Broken Install | ||
|
|
||
| ```bash | ||
| # First, diagnose what's wrong | ||
| node scripts/doctor.js --target antigravity | ||
|
|
||
| # Then, restore missing or drifted files | ||
| node scripts/repair.js --target antigravity | ||
| ``` | ||
greptile-apps[bot] marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### Uninstall | ||
|
|
||
| ```bash | ||
| node scripts/uninstall.js --target antigravity | ||
| ``` | ||
|
|
||
| ### Install State | ||
|
|
||
| The installer writes `.agent/ecc-install-state.json` to track which files ECC owns. This enables safe uninstall and repair — ECC will never touch files it didn't create. | ||
|
|
||
| ## Adding Custom Skills for Antigravity | ||
|
|
||
| If you're contributing a new skill and want it available on Antigravity: | ||
|
|
||
| 1. Create the skill under `skills/your-skill-name/SKILL.md` as usual | ||
| 2. Add an agent definition at `agents/your-skill-name.md` — this is the path the installer maps to `.agent/skills/` at runtime, making your skill available in the Antigravity harness | ||
| 3. Add the Antigravity agent config at `.agents/skills/your-skill-name/agents/openai.yaml` — this is a static repo layout consumed by Codex for implicit invocation metadata | ||
| 4. Mirror the `SKILL.md` content to `.agents/skills/your-skill-name/SKILL.md` — this static copy is used by Codex and serves as a reference for Antigravity | ||
| 5. Mention in your PR that you added Antigravity support | ||
|
|
||
| > **Key distinction**: The installer deploys `agents/` (no dot) → `.agent/skills/` — this is what makes skills available at runtime. The `.agents/` (dot-prefixed) directory is a separate static layout for Codex `openai.yaml` configs and is not auto-deployed by the installer. | ||
|
|
||
| See [CONTRIBUTING.md](../CONTRIBUTING.md) for the full contribution guide. | ||
|
|
||
| ## Comparison with Other Targets | ||
|
|
||
| | Feature | Claude Code | Cursor | Codex | Antigravity | | ||
| |---------|-------------|--------|-------|-------------| | ||
| | Install target | `claude-home` | `cursor-project` | `codex-home` | `antigravity` | | ||
| | Config root | `~/.claude/` | `.cursor/` | `~/.codex/` | `.agent/` | | ||
| | Scope | User-level | Project-level | User-level | Project-level | | ||
| | Rules format | Nested dirs | Flat | Flat | Flat | | ||
| | Commands | `commands/` | N/A | N/A | `workflows/` | | ||
| | Agents/Skills | `agents/` | N/A | N/A | `skills/` | | ||
| | Install state | `ecc-install-state.json` | `ecc-install-state.json` | `ecc-install-state.json` | `ecc-install-state.json` | | ||
|
|
||
coderabbitai[bot] marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## Troubleshooting | ||
|
|
||
| ### Skills not loading in Antigravity | ||
|
|
||
| - Verify the `.agent/` directory exists in your project root (not home directory) | ||
| - Check that `ecc-install-state.json` was created — if missing, re-run the installer | ||
| - Ensure files have `.md` extension and valid frontmatter | ||
vazidmansuri005 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### Rules not applying | ||
|
|
||
| - Rules must be in `.agent/rules/`, not nested in subdirectories | ||
| - Run `node scripts/doctor.js --target antigravity` to verify the install | ||
|
|
||
| ### Workflows not available | ||
|
|
||
| - Antigravity looks for workflows in `.agent/workflows/`, not `commands/` | ||
| - If you manually copied ECC commands, rename the directory | ||
|
|
||
| ## Related Resources | ||
|
|
||
| - [Selective Install Architecture](./SELECTIVE-INSTALL-ARCHITECTURE.md) — how the install system works under the hood | ||
| - [Selective Install Design](./SELECTIVE-INSTALL-DESIGN.md) — design decisions and target adapter contracts | ||
| - [CONTRIBUTING.md](../CONTRIBUTING.md) — how to contribute skills, agents, and commands | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.