Skip to content

Commit d4678e2

Browse files
authored
docs: update readme to connect with antigravity (#117)
1 parent 23a07b1 commit d4678e2

2 files changed

Lines changed: 68 additions & 42 deletions

File tree

.lycheeignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
https://github.com/gemini-cli-extensions/spanner/compare/
2+
https://www.npmjs.com/package/skills

README.md

Lines changed: 67 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
> [!NOTE]
44
> Currently in beta (pre-v1.0), and may see breaking changes until the first stable release (v1.0).
55
6-
This repository provides a set of agent skills to interact with [Google Cloud Spanner](https://cloud.google.com/spanner/docs) instances. These skills can be used with various AI agents, including [Gemini CLI](https://google-gemini.github.io/gemini-cli/), Claude Code, and Codex, to manage your databases, execute queries, explore schemas, and troubleshoot issues using natural language prompts.
6+
This repository provides a set of agent skills to interact with [Google Cloud Spanner](https://cloud.google.com/spanner/docs) instances. These skills can be used with various AI agents, including [Antigravity](https://antigravity.google/), [Claude Code](https://claude.com/product/claude-code) and [Codex](https://developers.openai.com/codex), to manage your databases, execute queries, explore schemas, and troubleshoot issues using natural language prompts.
77

88
> [!IMPORTANT]
99
> **We Want Your Feedback!**
@@ -19,10 +19,9 @@ This repository provides a set of agent skills to interact with [Google Cloud Sp
1919
- [Getting Started](#getting-started)
2020
- [Configuration](#configuration)
2121
- [Installation & Usage](#installation--usage)
22-
- [Gemini CLI](#gemini-cli)
22+
- [Antigravity](#antigravity)
2323
- [Claude Code](#claude-code)
2424
- [Codex](#codex)
25-
- [Antigravity](#antigravity)
2625
- [Usage Examples](#usage-examples)
2726
- [Supported Skills](#supported-skills)
2827
- [Additional Agent Skills](#additional-agent-skills)
@@ -40,10 +39,11 @@ This repository provides a set of agent skills to interact with [Google Cloud Sp
4039
Before you begin, ensure you have the following:
4140

4241
- One of these AI agents installed
43-
- [Gemini CLI](https://github.com/google-gemini/gemini-cli) version **v0.6.0** or higher
44-
- [Claude Code](https://claude.com/product/claude-code) version **v2.1.94** or higher
45-
- [Codex](https://developers.openai.com/codex) **v0.117.0** or higher
46-
- [Antigravity](https://antigravity.google) **v1.14.2** or higher
42+
- Antigravity
43+
- [Antigravity CLI](https://github.com/google-gemini/gemini-cli) version **v1.6.0** or higher
44+
- [Antigravity 2.0](https://antigravity.google/product/antigravity-2) version **v2.0.0** or higher.
45+
- [Claude Code](https://claude.com/product/claude-code) version **v2.1.94** or higher.
46+
- [Codex](https://developers.openai.com/codex) **v0.117.0** or higher.
4747
- A Google Cloud project with the **Spanner API** enabled.
4848
- Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
4949
- IAM Permissions:
@@ -76,34 +76,73 @@ For the latest version, check the [releases page][releases].
7676
<!-- {x-release-please-start-version} -->
7777

7878
<details open>
79-
<summary id="gemini-cli">Gemini CLI</summary>
79+
<summary id="antigravity">Antigravity</summary>
80+
81+
You can use either of these two agents for Antigravity:
82+
- [Antigravity CLI](https://github.com/google-gemini/gemini-cli) version **v1.6.0** or higher
83+
- [Antigravity 2.0](https://antigravity.google/product/antigravity-2) version **v2.0.0** or higher.
84+
85+
<blockquote>
86+
💡 <strong>Tip — Migrating from Gemini CLI?</strong><br>
87+
If you previously installed this extension with <code>gemini extensions install</code>, you can convert it to an Antigravity plugin instead of reinstalling from scratch:
88+
<ul>
89+
<li><strong>On first launch of Antigravity CLI</strong>, accept the Migration Options prompt to automatically convert your installed Gemini CLI extensions to Antigravity plugins.</li>
90+
<li><strong>Or, from your terminal</strong>, run:
91+
<pre><code class="language-bash">agy plugin import gemini</code></pre>
92+
</li>
93+
</ul>
94+
See <a href="https://antigravity.google/docs/gcli-migration">Migrating from Gemini CLI</a> for details on plugins, context files (<code>GEMINI.md</code> / <code>AGENTS.md</code>), and MCP server config differences.
95+
</blockquote>
96+
97+
#### Antigravity 2.0 (IDE)
98+
99+
**1. Clone the Repo:**
100+
101+
```bash
102+
git clone --branch 0.3.1 https://github.com/gemini-cli-extensions/spanner.git
103+
```
104+
105+
**2. Install the skills:**
80106

81-
**1. Install the extension:**
107+
Choose a location for the skills:
108+
- **Global (all workspaces):** `~/.gemini/antigravity/skills/`
109+
- **Workspace-specific:** `<workspace-root>/.agents/skills/`
110+
111+
Copy the skill folders from the cloned repository's `skills/` directory to your chosen location:
82112

83113
```bash
84-
gemini extensions install https://github.com/gemini-cli-extensions/spanner
114+
cp -R spanner/skills/* ~/.gemini/antigravity/skills/
85115
```
86116

87-
During the installation, enter your environment vars as described in the [configuration section](#configuration).
117+
**3. Set env vars:**
118+
Set your environment vars as described in the [configuration section](#configuration).
88119

89-
**2. (Optional) Manage Configuration:**
90-
To view or update your configuration in Gemini CLI:
120+
_(Tip: Antigravity 2.0 automatically discovers skills in these directories at the start of a session. You can verify they are active by running the `/skills` command in your active session.)_
91121

92-
- Terminal: `gemini extensions config spanner [setting name] [--scope <scope>]`
93-
- Gemini CLI: `/extensions list`
122+
#### Antigravity CLI
94123

95-
**3. Start the agent:**
124+
**1. Clone the Repo:**
96125

97126
```bash
98-
gemini
127+
git clone --branch 0.3.1 https://github.com/gemini-cli-extensions/spanner.git
99128
```
100129

101-
_(Tip: Run `/extensions list` to verify your configuration and active extensions.)_
130+
**2. Install the skills:**
102131

103-
> [!WARNING]
104-
> **Changing Instance & Database Connections**
105-
> Currently, the database connection must be configured before starting the agent and can not be changed during a session.
106-
> To save and resume conversation history in Gemini CLI use command: `/chat save <tag>` and `/chat resume <tag>`.
132+
Choose a location for the skills:
133+
- **Global (all workspaces):** `~/.gemini/antigravity-cli/skills/`
134+
- **Workspace-specific:** `<workspace-root>/.agents/skills/`
135+
136+
Copy the skill folders from the cloned repository's `skills/` directory to your chosen location:
137+
138+
```bash
139+
cp -R spanner/skills/* ~/.gemini/antigravity-cli/skills/
140+
```
141+
142+
**3. Set env vars:**
143+
Set your environment vars as described in the [configuration section](#configuration).
144+
145+
_(Tip: Antigravity CLI automatically discovers skills in these directories at the start of a session. You can verify they are active by running the `/skills` command in your active session.)_
107146

108147
</details>
109148

@@ -183,35 +222,21 @@ Enter your environment vars as described in the [configuration section](#configu
183222
_(Tip: Run `codex plugin list` or use the `/plugins` interactive menu to verify your installed plugins.)_
184223

185224
</details>
225+
## Installing using [open agent skills tool](https://github.com/vercel-labs/skills)
186226

187-
<details>
188-
<summary id="antigravity">Antigravity</summary>
227+
You can install skills using the `npx skills` command.
189228

190-
**1. Clone the Repo:**
229+
Run the following command in your terminal to automatically download and register the skills:
191230

192231
```bash
193-
git clone --branch 0.3.1 https://github.com/gemini-cli-extensions/spanner.git
232+
npx skills add https://github.com/gemini-cli-extensions/spanner/tree/0.3.1
194233
```
195234

196-
**2. Install the skills:**
235+
For detailed info check out the [Skills npm package](https://www.npmjs.com/package/skills).
197236

198-
Choose a location for the skills:
199-
- **Global (all workspaces):** `~/.gemini/antigravity/skills/`
200-
- **Workspace-specific:** `<workspace-root>/.agents/skills/`
201-
202-
Copy the skill folders from the cloned repository's `skills/` directory to your chosen location:
203-
204-
```bash
205-
cp -R spanner/skills/* ~/.gemini/antigravity/skills/
206-
```
207-
208-
**3. Set env vars:**
237+
**2. Set env vars:**
209238
Set your environment vars as described in the [configuration section](#configuration).
210239

211-
_(Tip: Antigravity automatically discovers skills in these directories at the start of a session.)_
212-
213-
</details>
214-
215240
<!-- {x-release-please-end} -->
216241

217242
## Usage Examples

0 commit comments

Comments
 (0)