Skip to content

docs: expose machine readable CLI documentation #643

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.

Sign up for GitHub

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

Closed
MattBetancourt wants to merge 1 commit into from
Closed

docs: expose machine readable CLI documentation #643

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions builtin/skills/antigravity_guide/references/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Antigravity CLI (`agy`) Reference

The Antigravity CLI (`agy`) is a lightweight, terminal-based interface for fast
agent interaction. For full details, always consult the live public
documentation:

- **CLI Features & Subagents**: `https://github.com/google-antigravity/antigravity-cli/blob/main/docs/features.md`
- **CLI Best Practices**: `https://github.com/google-antigravity/antigravity-cli/blob/main/docs/best-practices.md`
- **CLI Reference**: `https://github.com/google-antigravity/antigravity-cli/blob/main/docs/reference.md`

When the user asks about CLI specifics, **fetch the relevant page above** for
authoritative, up-to-date information.

--------------------------------------------------------------------------------

## 1. Getting Started

- **Launch**: Run `agy` to start the CLI.
- **Authentication**: On first run, follow the on-screen prompts to
authenticate. See `https://github.com/google-antigravity/antigravity-cli/blob/main/docs/reference.md` for
details.
- **Exit**: `Ctrl+D Ctrl+D` (or `/exit` or `/quit`).

--------------------------------------------------------------------------------

## 2. CLI Slash Commands

- **CLI flags & subcommands**: Run `agy --help` to see all command-line flags
and subcommands.
- **Slash commands** (inside the TUI): Launch `agy` and run `/help` to see all
available slash commands.
- **Full reference**: Fetch `https://github.com/google-antigravity/antigravity-cli/blob/main/docs/reference.md`
for the authoritative list of all slash commands and CLI options.

--------------------------------------------------------------------------------

## 3. Configuration

The CLI is configured via **`~/.gemini/antigravity-cli/settings.json`**. For the
full list of settings keys, types, and defaults, fetch the live docs:
`https://github.com/google-antigravity/antigravity-cli/blob/main/docs/reference.md`
Loading