Skip to content

README.md

Latest commit

 

History

History
132 lines (89 loc) · 4.2 KB

README.md

File metadata and controls

132 lines (89 loc) · 4.2 KB
Raw

codex-agy-plugin

codex-agy-plugin banner

Antigravity CLI (agy) integration for OpenAI Codex.

This is a small Codex plugin that teaches Codex how to call the local Antigravity CLI for second opinions, planning, code review, and delegated analysis.

Status

Experimental private MVP.

Requirements

  • Codex with plugin support.
  • Antigravity CLI installed, authenticated, available as agy; this plugin is tested with agy 1.0.6 and compatible print-mode arguments.
  • A trusted local workspace. Do not send secrets or unrelated private data to delegated prompts.

Check the local CLI:

command -v agy
agy --version
agy --help

Install From GitHub

Add this repository as a Codex plugin marketplace, then install the plugin:

codex plugin marketplace add sysCat64/codex-agy-plugin --ref main
codex plugin add codex-agy-plugin@codex-agy-plugin

For local development:

codex plugin marketplace add "$PWD"
codex plugin add codex-agy-plugin@codex-agy-plugin

After editing files under plugins/codex-agy-plugin/, rerun codex plugin add codex-agy-plugin@codex-agy-plugin so Codex refreshes its plugin cache. Start a new Codex thread after installing or reinstalling so the updated skill is loaded.

Usage

Ask Codex to use Antigravity:

Use agy to review the current diff.

Ask Antigravity for a second opinion on this implementation plan.

Delegate this bug investigation to agy and summarize what it finds.

Codex will use agy --print for non-interactive runs by default.

The plugin also ships plugins/codex-agy-plugin/scripts/agy-print.sh, a tiny wrapper around agy --print --print-timeout 10m. That path is for this repository checkout; installed Codex skills should resolve the wrapper from the plugin skill directory. Place wrapper options before PROMPT; arguments after PROMPT are included in the prompt text. Call agy directly when you need raw Antigravity CLI options that this wrapper does not accept.

Repository root scripts/validate*.sh files are development validators. plugins/codex-agy-plugin/scripts/agy-print.sh is the runtime wrapper shipped with the plugin.

plugins/codex-agy-plugin/scripts/agy-print.sh --print-timeout 15m "Review this repository. Do not modify files. Return findings only."

If the prompt begins with -, separate wrapper options from the prompt with --:

plugins/codex-agy-plugin/scripts/agy-print.sh -- "-starting prompt text"

For review and second-opinion requests, Codex should ask agy to return findings only and not modify files. For release-readiness or repeated reviews, Codex should pass a blocker-only prompt: report only High/Medium issues that can break install, runtime, validation, CI, or distribution; return APPROVED when there are no blockers.

Known Issues

On Windows, there is a report that agy --print can exit with code 0 but produce empty stdout when launched from Codex/non-interactive PowerShell, while the same command works from an interactive PowerShell session. See Issue #1.

This plugin relies on agy --print writing the final response to stdout. It does not read Antigravity internal transcript or log files as a fallback because those files are not a stable integration boundary.

Validate

scripts/validate.sh

Optional docs and local install validation:

scripts/validate-docs.sh
scripts/validate-install.sh

scripts/validate-install.sh is a local smoke test because GitHub-hosted runners do not provide the Codex CLI by default.

Before making the repository public or tagging a release, run the combined local readiness check:

scripts/test-public-readiness.sh

Repository Layout

.agents/plugins/marketplace.json
plugins/
  codex-agy-plugin/
    .codex-plugin/plugin.json
    LICENSE
    skills/agy/SKILL.md
    scripts/agy-print.sh
scripts/validate.sh
scripts/validate-docs.sh
scripts/validate-install.sh
scripts/test-public-readiness.sh

Notes

agy may need filesystem, network, or localhost bind permissions. If it fails inside a restricted Codex sandbox, approve the rerun only when the workspace and prompt are trusted.

License

MIT