Skip to content

armgit / ECC

Public Imported from GitHub
0

The agent harness performance optimization system. Skills, instincts, memory, security, and research-first development for Claude Code, Codex, Opencode, Cursor and beyond.

docs: add Antigravity setup and usage guide (#552)

vazidmansuri005cfb3370df8c0
diff --git a/README.md b/README.md
index 12457f4c4..ecc303b97 100644
--- a/README.md
+++ b/README.md
@@ -835,7 +835,7 @@ Yes. ECC is cross-platform:
- **Cursor**: Pre-translated configs in `.cursor/`. See [Cursor IDE Support](#cursor-ide-support).
- **OpenCode**: Full plugin support in `.opencode/`. See [OpenCode Support](#-opencode-support).
- **Codex**: First-class support for both macOS app and CLI, with adapter drift guards and SessionStart fallback. See PR [#257](https://github.com/affaan-m/everything-claude-code/pull/257).
-- **Antigravity**: Tightly integrated setup for workflows, skills, and flatten rules in `.agent/`.
+- **Antigravity**: Tightly integrated setup for workflows, skills, and flattened rules in `.agent/`. See [Antigravity Guide](docs/ANTIGRAVITY-GUIDE.md).
- **Claude Code**: Native — this is the primary target.
</details>
diff --git a/docs/ANTIGRAVITY-GUIDE.md b/docs/ANTIGRAVITY-GUIDE.md
new file mode 100644
index 000000000..d792aec9f
--- /dev/null
+++ b/docs/ANTIGRAVITY-GUIDE.md
@@ -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
+```
+
+### 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` |
+
+## 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
+
+### 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