You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/install-guides/antigravity.md
+48-43Lines changed: 48 additions & 43 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,9 @@
1
1
---
2
2
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.
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.
21
20
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.
23
22
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.
25
24
26
25
## Before you begin
27
26
28
27
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.
29
28
30
29
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.
33
32
34
33
35
34
## Install Antigravity CLI on macOS
36
35
37
36
You can install Antigravity CLI on macOS using either the official one-liner script or Homebrew.
38
37
39
-
### Option 1: Install using the official installer script (Recommended)
38
+
### (Recommended) Install using the official installer script
40
39
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:
The installer detects your macOS environment and downloads the appropriate binary. By default, the binary is installed to `~/.local/bin`.
48
47
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`):
50
49
51
50
```console
52
51
export PATH="$HOME/.local/bin:$PATH"
@@ -58,7 +57,7 @@ Apply the changes to your current terminal session:
58
57
source ~/.zshrc
59
58
```
60
59
61
-
### Option 2: Install using Homebrew
60
+
### Install using Homebrew
62
61
63
62
If you prefer using Homebrew for package management, you can install the CLI using the Homebrew cask:
The script automatically detects the CPU architecture (such as `aarch64` / `arm64`) and installs the compatible Arm Linux binary to `~/.local/bin`.
94
93
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`):
96
95
97
96
```bash
98
97
export PATH="$HOME/.local/bin:$PATH"
@@ -124,7 +123,7 @@ Start an interactive session to authenticate and test basic functionality:
124
123
agy
125
124
```
126
125
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.
128
127
129
128
### View the available command-line options
130
129
@@ -134,7 +133,7 @@ To print the available commands and options, use the `--help` flag:
134
133
agy --help
135
134
```
136
135
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`).
138
137
139
138
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:
140
139
@@ -144,55 +143,55 @@ agy plugin import gemini
144
143
145
144
## Configure context for Arm development
146
145
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.
148
147
149
148
### Create a context file
150
149
151
150
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.
154
153
155
-
Create the global configuration directory if it does not exist:
154
+
Create the global configuration directory if it doesn't already exist:
156
155
157
156
```console
158
157
mkdir -p ~/.gemini
159
158
```
160
159
161
-
Create a global context file with your Arm development preferences:
160
+
Create a global context file with your Arm development preferences. For example:
162
161
163
162
```console
164
163
cat > ~/.gemini/GEMINI.md << 'EOF'
165
164
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.
166
165
EOF
167
166
```
168
167
169
-
### Managing settings
168
+
### Manage settings
170
169
171
170
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.
174
173
175
174
---
176
175
177
-
## Integrate the Arm MCP server with Antigravity CLI
176
+
## Integrate the Arm MCP Server with Antigravity CLI
178
177
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.
180
179
181
180
Unlike the older Gemini CLI which stored MCP settings inline inside `settings.json`, Antigravity CLI uses a dedicated configuration file for managing MCP servers.
182
181
183
-
### Set up the Arm MCP server with Docker
182
+
### Set up the Arm MCP Server with Docker
184
183
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.
186
185
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.
188
187
189
-
Pull the Arm MCP server Docker image:
188
+
After ensuring Docker is running, pull the Arm MCP server Docker image:
190
189
191
190
```console
192
191
docker pull armlimited/arm-mcp:latest
193
192
```
194
193
195
-
### Configure Antigravity CLI to use the Arm MCP server
194
+
### Configure Antigravity CLI to use the Arm MCP Server
196
195
197
196
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).
198
197
@@ -222,17 +221,17 @@ Add the following JSON configuration to `~/.gemini/antigravity-cli/mcp_config.js
222
221
}
223
222
```
224
223
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.
226
225
227
-
### Optional: Use alternative container tools
226
+
### (Optional) Use alternative container tools
228
227
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.
230
229
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`:
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.
304
303
@@ -333,7 +332,7 @@ Add the following configuration to `~/.gemini/antigravity-cli/mcp_config.json`:
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.
400
399
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.
403
401
404
402
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/).
0 commit comments