Skip to content

Commit 33841b1

Browse files
Merge pull request #3326 from anupras-mohapatra-arm/install-guides
Antigravity CLI documentation review
2 parents 184d008 + a087323 commit 33841b1

2 files changed

Lines changed: 49 additions & 44 deletions

File tree

content/install-guides/antigravity.md

Lines changed: 48 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
title: Antigravity CLI
3+
description: Install Antigravity CLI on macOS and Arm Linux to interact with the Antigravity 2.0 development platform, then integrate it with the Arm MCP Server for Arm-focused development.
34
author: Jason Andrews
45
minutes_to_complete: 15
5-
official_docs: https://antigravity.google/
6-
7-
draft: true
6+
official_docs: https://www.antigravity.google/docs/cli-overview
87

98
test_maintenance: true
109
test_images:
@@ -19,34 +18,34 @@ weight: 1
1918

2019
Antigravity CLI is Google's terminal-based interface for interacting with the Antigravity 2.0 agent-first development platform. You can use it to ask questions, perform multi-file code editing, and invoke AI agents directly from your terminal.
2120

22-
It supports multiple operating systems, including Arm Linux distributions and macOS, and provides powerful AI assistance for developers working on Arm platforms.
21+
Antigravity CLI supports multiple operating systems, including Arm Linux distributions and macOS. It provides AI assistance for developers working on Arm platforms.
2322

24-
In this guide, you'll learn how to install Antigravity CLI on macOS and Arm Linux.
23+
In this guide, you'll learn how to install Antigravity CLI on macOS and Arm Linux, then integrate it with the Arm MCP server for Arm architecture development.
2524

2625
## Before you begin
2726

2827
You need a Google account to use Antigravity CLI. If you don't have one, visit [Google Account Creation](https://accounts.google.com/signup) to create an account.
2928

3029
After installation, running the tool (via the `agy` command) will initiate the authentication process:
31-
- **Local Machine:** It will automatically open your default browser for Google Sign-In.
32-
- **Remote/SSH Sessions:** It will detect the environment and print a secure authorization URL that you can copy and open in your local browser to complete the login.
30+
- Local machine: It will automatically open your default browser for Google Sign-In.
31+
- Remote/SSH sessions: It will detect the environment and print a secure authorization URL that you can copy and open in your local browser to complete the login.
3332

3433

3534
## Install Antigravity CLI on macOS
3635

3736
You can install Antigravity CLI on macOS using either the official one-liner script or Homebrew.
3837

39-
### Option 1: Install using the official installer script (Recommended)
38+
### (Recommended) Install using the official installer script
4039

41-
First, verify that `curl` is available on your system, then run the installer:
40+
To install using the official installer script, first verify that `curl` is available on your system. Then, run the installer:
4241

4342
```console
4443
curl -fsSL https://antigravity.google/cli/install.sh | bash
4544
```
4645

4746
The installer detects your macOS environment and downloads the appropriate binary. By default, the binary is installed to `~/.local/bin`.
4847

49-
To run the command globally, ensure this directory is included in your system's `PATH`. Add the following line to your shell configuration file (e.g., `~/.zshrc` or `~/.bash_profile`):
48+
To run the command globally, ensure this directory is included in your system's `PATH`. Add the following line to your shell configuration file (For example, `~/.zshrc` or `~/.bash_profile`):
5049

5150
```console
5251
export PATH="$HOME/.local/bin:$PATH"
@@ -58,7 +57,7 @@ Apply the changes to your current terminal session:
5857
source ~/.zshrc
5958
```
6059

61-
### Option 2: Install using Homebrew
60+
### Install using Homebrew
6261

6362
If you prefer using Homebrew for package management, you can install the CLI using the Homebrew cask:
6463

@@ -92,7 +91,7 @@ curl -fsSL https://antigravity.google/cli/install.sh | bash
9291

9392
The script automatically detects the CPU architecture (such as `aarch64` / `arm64`) and installs the compatible Arm Linux binary to `~/.local/bin`.
9493

95-
Ensure the installation directory is in your `PATH` by adding it to your shell configuration file (e.g., `~/.bashrc` or `~/.zshrc`):
94+
Ensure the installation directory is in your `PATH` by adding it to your shell configuration file (For example, `~/.bashrc` or `~/.zshrc`):
9695

9796
```bash
9897
export PATH="$HOME/.local/bin:$PATH"
@@ -124,7 +123,7 @@ Start an interactive session to authenticate and test basic functionality:
124123
agy
125124
```
126125

127-
This launches the terminal user interface (TUI). On your first run, follow the prompt to authenticate with your Google account. Once authenticated, you can immediately begin asking questions.
126+
The command launches the terminal user interface (TUI). On your first run, follow the prompt to authenticate with your Google account. After you've authenticated, you can start asking questions.
128127

129128
### View the available command-line options
130129

@@ -134,7 +133,7 @@ To print the available commands and options, use the `--help` flag:
134133
agy --help
135134
```
136135

137-
Inside the interactive TUI session, you can type `?` to list all available slash commands (e.g., `/settings`, `/clear`, `/fork`, `/logout`).
136+
Inside the interactive TUI session, you can type `?` to list all available slash commands (For example, `/settings`, `/clear`, `/fork`, `/logout`).
138137

139138
If you are migrating from the older Gemini CLI, you can use the built-in migration command to import your existing settings, skills, and configuration:
140139

@@ -144,55 +143,55 @@ agy plugin import gemini
144143

145144
## Configure context for Arm development
146145

147-
Context configuration allows you to provide the Antigravity agent with persistent information about your development environment, preferences, and project details. This helps it generate highly relevant and tailored responses for Arm architecture development.
146+
You can use context configuration to provide the Antigravity agent with persistent information about your development environment, preferences, and project details. Context helps the agent generate relevant and tailored responses for Arm architecture development.
148147

149148
### Create a context file
150149

151150
Antigravity CLI respects both global and workspace-level context files to guide agent behavior:
152-
- **Global Context:** The CLI automatically loads and enforces user-wide rules located at `~/.gemini/GEMINI.md` across all workspaces.
153-
- **Workspace Context:** The CLI reads `.antigravity.md` (recommended for Antigravity CLI) or `GEMINI.md` (fully supported for backward compatibility) as well as `AGENTS.md` from your active project directory. If both `.antigravity.md` and `GEMINI.md` are present, `.antigravity.md` takes precedence.
151+
- Global context: The CLI automatically loads and enforces user-wide rules located at `~/.gemini/GEMINI.md` across all workspaces.
152+
- Workspace context: The CLI reads `.antigravity.md` (recommended for Antigravity CLI) or `GEMINI.md` (fully supported for backward compatibility), as well as `AGENTS.md` from your active project directory. If both `.antigravity.md` and `GEMINI.md` are present, `.antigravity.md` takes precedence.
154153

155-
Create the global configuration directory if it does not exist:
154+
Create the global configuration directory if it doesn't already exist:
156155

157156
```console
158157
mkdir -p ~/.gemini
159158
```
160159

161-
Create a global context file with your Arm development preferences:
160+
Create a global context file with your Arm development preferences. For example:
162161

163162
```console
164163
cat > ~/.gemini/GEMINI.md << 'EOF'
165164
I am an Arm Linux developer. I prefer Ubuntu and other Debian based distributions. I don't use any x86 computers so please provide all information assuming I'm working on Arm Linux. Sometimes I use macOS and Windows on Arm, but please only provide information about these operating systems when I ask for it.
166165
EOF
167166
```
168167

169-
### Managing settings
168+
### Manage settings
170169

171170
Antigravity CLI settings are stored in `~/.gemini/antigravity-cli/settings.json`. You can manage settings in two ways:
172-
1. **Interactive Menu:** Run `agy` and type `/settings` or `/config` to open a full-screen overlay menu to browse and modify settings.
173-
2. **Manual Editing:** Open `~/.gemini/antigravity-cli/settings.json` in a text editor to update your preferences manually.
171+
- Interactive menu: Run `agy` and type `/settings` or `/config` to open a full-screen overlay menu to browse and modify settings.
172+
- Manual editing: Open `~/.gemini/antigravity-cli/settings.json` in a text editor to update your preferences manually.
174173

175174
---
176175

177-
## Integrate the Arm MCP server with Antigravity CLI
176+
## Integrate the Arm MCP Server with Antigravity CLI
178177

179-
The Arm Model Context Protocol (MCP) server provides Antigravity CLI with specialized tools and knowledge for Arm architecture development, migration, and optimization. By integrating the Arm MCP server, you gain access to Arm-specific documentation, code analysis tools, and optimization recommendations.
178+
The Arm Model Context Protocol (MCP) Server provides Antigravity CLI with specialized tools and knowledge for Arm architecture development, migration, and optimization. By integrating the Arm MCP Server, you gain access to Arm-specific documentation, code analysis tools, and optimization recommendations.
180179

181180
Unlike the older Gemini CLI which stored MCP settings inline inside `settings.json`, Antigravity CLI uses a dedicated configuration file for managing MCP servers.
182181

183-
### Set up the Arm MCP server with Docker
182+
### Set up the Arm MCP Server with Docker
184183

185-
The Arm MCP server runs as a Docker container that Antigravity CLI connects to via the Model Context Protocol.
184+
The Arm MCP Server runs as a Docker container that Antigravity CLI connects to using the Model Context Protocol.
186185

187-
First, ensure Docker is installed and running on your system. If needed, follow the [Docker installation guide](/install-guides/docker/).
186+
First, ensure Docker is installed and running on your system. If needed, follow the [Docker installation guide](/install-guides/docker/) to set up Docker.
188187

189-
Pull the Arm MCP server Docker image:
188+
After ensuring Docker is running, pull the Arm MCP server Docker image:
190189

191190
```console
192191
docker pull armlimited/arm-mcp:latest
193192
```
194193

195-
### Configure Antigravity CLI to use the Arm MCP server
194+
### Configure Antigravity CLI to use the Arm MCP Server
196195

197196
Create or update the dedicated global MCP configuration file at `~/.gemini/antigravity-cli/mcp_config.json` (or `.agents/mcp_config.json` inside your active workspace to enable it only for a specific project).
198197

@@ -222,17 +221,17 @@ Add the following JSON configuration to `~/.gemini/antigravity-cli/mcp_config.js
222221
}
223222
```
224223

225-
Replace `/path/to/your/workspace`, `/path/to/your/ssh/private_key`, and `/path/to/your/ssh/known_hosts` with your actual workspace directory, SSH private key, and `known_hosts` file to enable remote testing features on your target device.
224+
Replace `/path/to/your/workspace`, `/path/to/your/ssh/private_key`, and `/path/to/your/ssh/known_hosts` with your workspace directory, SSH private key, and `known_hosts` file to enable remote testing features on your target device.
226225

227-
### Optional: Use alternative container tools
226+
### (Optional) Use alternative container tools
228227

229-
If you prefer not to use Docker, you can run the Arm MCP server using other compatible container tools such as Podman, Finch, Colima, or Rancher Desktop.
228+
If you prefer not to use Docker, you can run the Arm MCP Server using other compatible container tools such as Podman, Finch, Colima, or Rancher Desktop.
230229

231-
Select your container tool from the tabs below to view setup instructions and configuration for `~/.gemini/antigravity-cli/mcp_config.json`:
230+
Select your container tool from the following tabs to view setup instructions and configuration for `~/.gemini/antigravity-cli/mcp_config.json`:
232231

233232
{{< tabpane-normal >}}
234233
{{< tab header="Podman" >}}
235-
Install: [Podman](https://podman.io/docs/installation)
234+
Install [Podman](https://podman.io/docs/installation).
236235

237236
Pull the Arm MCP Server image:
238237
```console
@@ -265,7 +264,7 @@ Add the following configuration to `~/.gemini/antigravity-cli/mcp_config.json`:
265264
```
266265
{{< /tab >}}
267266
{{< tab header="Finch" >}}
268-
Install: [Finch](/install-guides/finch/)
267+
Install [Finch](/install-guides/finch/).
269268

270269
Pull the Arm MCP Server image:
271270
```console
@@ -298,7 +297,7 @@ Add the following configuration to `~/.gemini/antigravity-cli/mcp_config.json`:
298297
```
299298
{{< /tab >}}
300299
{{< tab header="Colima" >}}
301-
Install: [Colima](https://github.com/abiosoft/colima#installation)
300+
Install [Colima](https://github.com/abiosoft/colima#installation).
302301

303302
Colima is a lightweight, open-source command-line alternative to Docker Desktop (primarily for macOS). It runs a minimal virtual machine in the background, allowing you to use your standard `docker` command-line tool without installing Docker Desktop.
304303

@@ -333,7 +332,7 @@ Add the following configuration to `~/.gemini/antigravity-cli/mcp_config.json`:
333332
```
334333
{{< /tab >}}
335334
{{< tab header="Rancher Desktop" >}}
336-
Install: [Rancher Desktop](https://docs.rancherdesktop.io/getting-started/installation/)
335+
Install [Rancher Desktop](https://docs.rancherdesktop.io/getting-started/installation/).
337336

338337
Rancher Desktop uses Docker via Moby.
339338

@@ -369,7 +368,7 @@ Add the following configuration to `~/.gemini/antigravity-cli/mcp_config.json`:
369368
{{< /tab >}}
370369
{{< /tabpane-normal >}}
371370

372-
### Verify the Arm MCP server is working
371+
### Verify the Arm MCP Server is working
373372

374373
Start an interactive Antigravity CLI session:
375374

@@ -383,7 +382,7 @@ Use the `/mcp` command to list the active MCP servers and verify that `arm_mcp_s
383382
/mcp
384383
```
385384

386-
The Arm MCP server tools are listed in the output:
385+
The output lists the Arm MCP Server tools and is similar to:
387386

388387
```output
389388
MCP Servers
@@ -394,11 +393,17 @@ Plugins (~/.gemini/antigravity-cli/plugins)
394393
```
395394

396395

397-
### Use Arm prompt files with the MCP Server
396+
### Use Arm prompt files with the MCP server
398397

399-
To guide the agent in using MCP tools effectively across common Arm development tasks, pair the server with Arm-specific prompt files.
398+
To guide the agent in using MCP tools effectively across common Arm development tasks, pair the MCP server with Arm-specific prompt files.
400399

401-
Browse the [agent integrations directory](https://github.com/arm/mcp/tree/main/agent-integrations/gemini) to find prompt files for specific use cases, such as:
402-
- **Arm migration** ([arm-migration.toml](https://github.com/arm/mcp/blob/main/agent-integrations/gemini/arm-migration.toml)): Helps the agent systematically migrate applications from x86 to Arm, including dependency analysis, compatibility checks, and optimization recommendations.
400+
Browse the [agent integrations directory](https://github.com/arm/mcp/tree/main/agent-integrations/gemini) to find prompt files for specific use cases, such as Arm migration ([arm-migration.toml](https://github.com/arm/mcp/blob/main/agent-integrations/gemini/arm-migration.toml)). The Arm migration prompt file helps the agent systematically migrate applications from x86 to Arm, including dependency analysis, compatibility checks, and optimization recommendations.
403401

404402
If you are facing issues or have questions, reach out to mcpserver@arm.com.
403+
404+
## Next steps
405+
406+
You're now ready to use Antigravity CLI for Arm architecture development, migration, and optimization.
407+
408+
To test a workflow for migrating an application from x86 to Arm, see the Learning Path [Automate x86-to-Arm application migration using the Arm MCP server](/learning-paths/servers-and-cloud-computing/arm-mcp-server/).
409+

content/learning-paths/servers-and-cloud-computing/arm-mcp-server/1-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ The required configuration steps vary by AI coding assistant. Refer to the insta
9191

9292
- [GitHub Copilot](/install-guides/github-copilot/)
9393
- [Claude Code](/install-guides/claude-code/)
94-
- [Gemini CLI](/install-guides/gemini/)
94+
- [Antigravity CLI](/install-guides/antigravity/)
9595
- [Kiro CLI](/install-guides/kiro-cli/)
9696
- [Codex CLI](/install-guides/codex-cli/)
9797

0 commit comments

Comments
 (0)