Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .lycheeignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
https://github.com/gemini-cli-extensions/alloydb/compare/
https://www.npmjs.com/package/skills
189 changes: 150 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
> [!NOTE]
> Currently in beta (pre-v1.0), and may see breaking changes until the first stable release (v1.0).

This repository provides a set of agent skills to interact with [AlloyDB for PostgreSQL](https://cloud.google.com/alloydb) 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.
This repository provides a set of agent skills to interact with [AlloyDB for PostgreSQL](https://cloud.google.com/alloydb) 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.

> [!IMPORTANT]
> **We Want Your Feedback!**
Expand All @@ -19,10 +19,9 @@ This repository provides a set of agent skills to interact with [AlloyDB for Pos
- [Getting Started](#getting-started)
- [Configuration](#configuration)
- [Installation & Usage](#installation--usage)
- [Gemini CLI](#gemini-cli)
- [Antigravity](#antigravity)
- [Claude Code](#claude-code)
- [Codex](#codex)
- [Antigravity](#antigravity)
- [Usage Examples](#usage-examples)
- [Supported Skills](#supported-skills)
- [Additional Agent Skills](#additional-agent-skills)
Expand All @@ -40,10 +39,11 @@ This repository provides a set of agent skills to interact with [AlloyDB for Pos
Before you begin, ensure you have the following:

- One of these AI agents installed
- [Gemini CLI](https://github.com/google-gemini/gemini-cli) version **v0.6.0** or higher
- [Claude Code](https://claude.com/product/claude-code) version **v2.1.94** or higher
- [Codex](https://developers.openai.com/codex) **v0.117.0** or higher
- [Antigravity](https://antigravity.google) **v1.14.2** or higher
- Antigravity
- [Antigravity CLI](https://github.com/google-gemini/gemini-cli) version **v1.6.0** or higher
- [Antigravity 2.0](https://antigravity.google/product/antigravity-2) version **v2.0.0** or higher.
- [Claude Code](https://claude.com/product/claude-code) version **v2.1.94** or higher.
- [Codex](https://developers.openai.com/codex) **v0.117.0** or higher.
- A Google Cloud project with the **AlloyDB API** enabled.
- Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
- IAM Permissions:
Expand Down Expand Up @@ -78,40 +78,150 @@ For the latest version, check the [releases page][releases].

<!-- {x-release-please-start-version} -->

[releases]: https://github.com/gemini-cli-extensions/alloydb/releases
<details open>
<summary id="antigravity">Antigravity</summary>

You can use either of these two agents for Antigravity:
- [Antigravity CLI](https://github.com/google-gemini/gemini-cli) version **v1.6.0** or higher
- [Antigravity 2.0](https://antigravity.google/product/antigravity-2) version **v2.0.0** or higher.

<blockquote>
💡 <strong>Tip — Migrating from Gemini CLI?</strong><br>
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:
<ul>
<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>
<li><strong>Or, from your terminal</strong>, run:
<pre><code class="language-bash">agy plugin import gemini</code></pre>
</li>
</ul>
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.
</blockquote>

#### Antigravity 2.0 (IDE)

**1. Clone the Repo:**

```bash
git clone --branch 0.2.0 https://github.com/gemini-cli-extensions/alloydb.git
```

**2. Install the skills:**

Choose a location for the skills:
- **Global (all workspaces):** `~/.gemini/antigravity/skills/`
- **Workspace-specific:** `<workspace-root>/.agents/skills/`

Copy the skill folders from the cloned repository's `skills/` directory to your chosen location:

```bash
cp -R alloydb/skills/* ~/.gemini/antigravity/skills/
```

**3. Set env vars:**
Set your environment vars as described in the [configuration section](#configuration).

_(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.)_

#### Antigravity CLI

**1. Clone the Repo:**

```bash
git clone --branch 0.2.0 https://github.com/gemini-cli-extensions/alloydb.git
```

**2. Install the skills:**

Choose a location for the skills:
- **Global (all workspaces):** `~/.gemini/antigravity-cli/skills/`
- **Workspace-specific:** `<workspace-root>/.agents/skills/`

Copy the skill folders from the cloned repository's `skills/` directory to your chosen location:

```bash
cp -R alloydb/skills/* ~/.gemini/antigravity-cli/skills/
```

**3. Set env vars:**
Set your environment vars as described in the [configuration section](#configuration).

_(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.)_

</details>

<details open>
<summary id="gemini-cli">Gemini CLI</summary>
<summary id="antigravity">Antigravity</summary>

You can use either of these two agents for Antigravity:
- [Antigravity CLI](https://github.com/google-gemini/gemini-cli) version **v1.6.0** or higher
- [Antigravity 2.0](https://antigravity.google/product/antigravity-2) version **v2.0.0** or higher.

**1. Install the extension:**
<blockquote>
💡 <strong>Tip — Migrating from Gemini CLI?</strong><br>
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:
<ul>
<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>
<li><strong>Or, from your terminal</strong>, run:
<pre><code class="language-bash">agy plugin import gemini</code></pre>
</li>
</ul>
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.
</blockquote>

#### Antigravity 2.0 (IDE)

**1. Clone the Repo:**

```bash
gemini extensions install https://github.com/gemini-cli-extensions/alloydb
git clone --branch 0.2.0 https://github.com/gemini-cli-extensions/alloydb.git
```

During the installation, enter your environment vars as described in the [configuration section](#configuration).
**2. Install the skills:**

Choose a location for the skills:
- **Global (all workspaces):** `~/.gemini/antigravity/skills/`
- **Workspace-specific:** `<workspace-root>/.agents/skills/`

Copy the skill folders from the cloned repository's `skills/` directory to your chosen location:

**2. (Optional) Manage Configuration:**
To view or update your configuration in Gemini CLI:
```bash
cp -R alloydb/skills/* ~/.gemini/antigravity/skills/
```

**3. Set env vars:**
Set your environment vars as described in the [configuration section](#configuration).

_(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.)_

#### Antigravity CLI

**1. Clone the Repo:**

```bash
git clone --branch 0.2.0 https://github.com/gemini-cli-extensions/alloydb.git
```

**2. Install the skills:**

- Terminal: `gemini extensions config alloydb [setting name] [--scope <scope>]`
- Gemini CLI: `/extensions list`
Choose a location for the skills:
- **Global (all workspaces):** `~/.gemini/antigravity-cli/skills/`
- **Workspace-specific:** `<workspace-root>/.agents/skills/`

**3. Start the agent:**
Copy the skill folders from the cloned repository's `skills/` directory to your chosen location:

```bash
gemini
cp -R alloydb/skills/* ~/.gemini/antigravity-cli/skills/
```

_(Tip: Run `/extensions list` to verify your configuration and active extensions.)_
**3. Set env vars:**
Set your environment vars as described in the [configuration section](#configuration).

> [!WARNING]
> **Changing Instance & Database Connections**
> Currently, the database connection must be configured before starting the agent and can not be changed during a session.
> To save and resume conversation history in Gemini CLI use command: `/chat save <tag>` and `/chat resume <tag>`.
_(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.)_

</details>
Comment on lines 151 to 221

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The "Antigravity" installation instructions block is duplicated. This second identical block should be removed.


[releases]: https://github.com/gemini-cli-extensions/alloydb/releases

<details>
<summary id="claude-code">Claude Code</summary>

Expand Down Expand Up @@ -182,34 +292,35 @@ Enter your environment vars as described in the [configuration section](#configu
_(Tip: Run `codex plugin list` or use the `/plugins` interactive menu to verify your installed plugins.)_

</details>
<details>
<summary id="antigravity">Antigravity</summary>
## Installing using [open agent skills tool](https://github.com/vercel-labs/skills)

**1. Clone the Repo:**
You can install skills using the `npx skills` command.

Run the following command in your terminal to automatically download and register the skills:

```bash
git clone --branch 0.2.0 https://github.com/gemini-cli-extensions/alloydb.git
npx skills add https://github.com/gemini-cli-extensions/alloydb/tree/0.2.0
```

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

Choose a location for the skills:
- **Global (all workspaces):** `~/.gemini/antigravity/skills/`
- **Workspace-specific:** `<workspace-root>/.agents/skills/`
**2. Set env vars:**
Set your environment vars as described in the [configuration section](#configuration).

Copy the skill folders from the cloned repository's `skills/` directory to your chosen location:
## Installing using [open agent skills tool](https://github.com/vercel-labs/skills)

```bash
cp -R alloydb/skills/* ~/.gemini/antigravity/skills/
```
You can install skills using the `npx skills` command.

**3. Set env vars:**
Set your environment vars as described in the [configuration section](#configuration).
Run the following command in your terminal to automatically download and register the skills:

_(Tip: Antigravity automatically discovers skills in these directories at the start of a session.)_
```bash
npx skills add https://github.com/gemini-cli-extensions/alloydb/tree/0.2.0
```

</details>
For detailed info check out the [Skills npm package](https://www.npmjs.com/package/skills).

**2. Set env vars:**
Set your environment vars as described in the [configuration section](#configuration).
Comment on lines 309 to +323

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The "Installing using open agent skills tool" section is duplicated. This second identical block should be removed.


<!-- {x-release-please-end} -->

Expand Down