Skip to content

Commit aff97e7

Browse files
authored
docs: update readme to connect with antigravity (#115)
1 parent dd3f7b0 commit aff97e7

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/firestore-native/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 [Firestore](https://cloud.google.com/firestore/docs) databases. 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, collections, and documents using natural language prompts.
6+
This repository provides a set of agent skills to interact with [Firestore](https://cloud.google.com/firestore/docs) databases. 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, collections, and documents 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 [Firestore](http
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)
@@ -46,10 +45,11 @@ Follow this step-by-step video walkthrough to setup and use the Firestore Native
4645
Before you begin, ensure you have the following:
4746

4847
- One of these AI agents installed
49-
- [Gemini CLI](https://github.com/google-gemini/gemini-cli) version **v0.6.0** or higher
50-
- [Claude Code](https://claude.com/product/claude-code) version **v2.1.94** or higher
51-
- [Codex](https://developers.openai.com/codex) **v0.117.0** or higher
52-
- [Antigravity](https://antigravity.google) **v1.14.2** or higher
48+
- Antigravity
49+
- [Antigravity CLI](https://github.com/google-gemini/gemini-cli) version **v1.6.0** or higher
50+
- [Antigravity 2.0](https://antigravity.google/product/antigravity-2) version **v2.0.0** or higher.
51+
- [Claude Code](https://claude.com/product/claude-code) version **v2.1.94** or higher.
52+
- [Codex](https://developers.openai.com/codex) **v0.117.0** or higher.
5353
- A Google Cloud project with the **Firestore API** enabled.
5454
- Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
5555
- IAM Permissions:
@@ -80,34 +80,73 @@ For the latest version, check the [releases page][releases].
8080
<!-- {x-release-please-start-version} -->
8181

8282
<details open>
83-
<summary id="gemini-cli">Gemini CLI</summary>
83+
<summary id="antigravity">Antigravity</summary>
84+
85+
You can use either of these two agents for Antigravity:
86+
- [Antigravity CLI](https://github.com/google-gemini/gemini-cli) version **v1.6.0** or higher
87+
- [Antigravity 2.0](https://antigravity.google/product/antigravity-2) version **v2.0.0** or higher.
88+
89+
<blockquote>
90+
💡 <strong>Tip — Migrating from Gemini CLI?</strong><br>
91+
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:
92+
<ul>
93+
<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>
94+
<li><strong>Or, from your terminal</strong>, run:
95+
<pre><code class="language-bash">agy plugin import gemini</code></pre>
96+
</li>
97+
</ul>
98+
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.
99+
</blockquote>
100+
101+
#### Antigravity 2.0 (IDE)
102+
103+
**1. Clone the Repo:**
104+
105+
```bash
106+
git clone --branch 0.3.0 https://github.com/gemini-cli-extensions/firestore-native.git
107+
```
108+
109+
**2. Install the skills:**
84110

85-
**1. Install the extension:**
111+
Choose a location for the skills:
112+
- **Global (all workspaces):** `~/.gemini/antigravity/skills/`
113+
- **Workspace-specific:** `<workspace-root>/.agents/skills/`
114+
115+
Copy the skill folders from the cloned repository's `skills/` directory to your chosen location:
86116

87117
```bash
88-
gemini extensions install https://github.com/gemini-cli-extensions/firestore-native
118+
cp -R firestore-native/skills/* ~/.gemini/antigravity/skills/
89119
```
90120

91-
During the installation, enter your environment vars as described in the [configuration section](#configuration).
121+
**3. Set env vars:**
122+
Set your environment vars as described in the [configuration section](#configuration).
92123

93-
**2. (Optional) Manage Configuration:**
94-
To view or update your configuration in Gemini CLI:
124+
_(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.)_
95125

96-
- Terminal: `gemini extensions config firestore-native [setting name] [--scope <scope>]`
97-
- Gemini CLI: `/extensions list`
126+
#### Antigravity CLI
98127

99-
**3. Start the agent:**
128+
**1. Clone the Repo:**
100129

101130
```bash
102-
gemini
131+
git clone --branch 0.3.0 https://github.com/gemini-cli-extensions/firestore-native.git
103132
```
104133

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

107-
> [!WARNING]
108-
> **Changing Database Connections**
109-
> Currently, the database connection must be configured before starting the agent and can not be changed during a session.
110-
> To save and resume conversation history in Gemini CLI use command: `/chat save <tag>` and `/chat resume <tag>`.
136+
Choose a location for the skills:
137+
- **Global (all workspaces):** `~/.gemini/antigravity-cli/skills/`
138+
- **Workspace-specific:** `<workspace-root>/.agents/skills/`
139+
140+
Copy the skill folders from the cloned repository's `skills/` directory to your chosen location:
141+
142+
```bash
143+
cp -R firestore-native/skills/* ~/.gemini/antigravity-cli/skills/
144+
```
145+
146+
**3. Set env vars:**
147+
Set your environment vars as described in the [configuration section](#configuration).
148+
149+
_(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.)_
111150

112151
</details>
113152

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

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

191-
<details>
192-
<summary id="antigravity">Antigravity</summary>
231+
You can install skills using the `npx skills` command.
193232

194-
**1. Clone the Repo:**
233+
Run the following command in your terminal to automatically download and register the skills:
195234

196235
```bash
197-
git clone --branch 0.3.0 https://github.com/gemini-cli-extensions/firestore-native.git
236+
npx skills add https://github.com/gemini-cli-extensions/firestore-native/tree/0.3.0
198237
```
199238

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

202-
Choose a location for the skills:
203-
- **Global (all workspaces):** `~/.gemini/antigravity/skills/`
204-
- **Workspace-specific:** `<workspace-root>/.agents/skills/`
205-
206-
Copy the skill folders from the cloned repository's `skills/` directory to your chosen location:
207-
208-
```bash
209-
cp -R firestore-native/skills/* ~/.gemini/antigravity/skills/
210-
```
211-
212-
**3. Set env vars:**
241+
**2. Set env vars:**
213242
Set your environment vars as described in the [configuration section](#configuration).
214243

215-
_(Tip: Antigravity automatically discovers skills in these directories at the start of a session.)_
216-
217-
</details>
218-
219244
<!-- {x-release-please-end} -->
220245

221246
## Usage Examples

0 commit comments

Comments
 (0)