From 03f171269ef40687cfef3c342f15f7e980b4a426 Mon Sep 17 00:00:00 2001 From: Twisha Bansal Date: Tue, 26 May 2026 20:43:40 +0530 Subject: [PATCH] docs: update readme to connect with antigravity --- .lycheeignore | 1 + README.md | 109 +++++++++++++++++++++++++++++++------------------- 2 files changed, 68 insertions(+), 42 deletions(-) diff --git a/.lycheeignore b/.lycheeignore index d9acff1..bb6f622 100644 --- a/.lycheeignore +++ b/.lycheeignore @@ -1 +1,2 @@ https://github.com/gemini-cli-extensions/spanner/compare/ +https://www.npmjs.com/package/skills diff --git a/README.md b/README.md index e6c761b..5f9af2a 100644 --- a/README.md +++ b/README.md @@ -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 [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. +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. > [!IMPORTANT] > **We Want Your Feedback!** @@ -19,10 +19,9 @@ This repository provides a set of agent skills to interact with [Google Cloud Sp - [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) @@ -40,10 +39,11 @@ This repository provides a set of agent skills to interact with [Google Cloud Sp 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 **Spanner API** enabled. - Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment. - IAM Permissions: @@ -76,34 +76,73 @@ For the latest version, check the [releases page][releases].
-Gemini CLI +Antigravity + +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. + +
+💡 Tip — Migrating from Gemini CLI?
+If you previously installed this extension with gemini extensions install, you can convert it to an Antigravity plugin instead of reinstalling from scratch: +
    +
  • On first launch of Antigravity CLI, accept the Migration Options prompt to automatically convert your installed Gemini CLI extensions to Antigravity plugins.
    • +
  • Or, from your terminal, run: + 
    agy plugin import gemini
    +
    • +
+See Migrating from Gemini CLI for details on plugins, context files (GEMINI.md / AGENTS.md), and MCP server config differences. +
+ +#### Antigravity 2.0 (IDE) + +**1. Clone the Repo:** + +```bash +git clone --branch 0.3.1 https://github.com/gemini-cli-extensions/spanner.git +``` + +**2. Install the skills:** -**1. Install the extension:** +Choose a location for the skills: +- **Global (all workspaces):** `~/.gemini/antigravity/skills/` +- **Workspace-specific:** `/.agents/skills/` + +Copy the skill folders from the cloned repository's `skills/` directory to your chosen location: ```bash -gemini extensions install https://github.com/gemini-cli-extensions/spanner +cp -R spanner/skills/* ~/.gemini/antigravity/skills/ ``` -During the installation, enter your environment vars as described in the [configuration section](#configuration). +**3. Set env vars:** +Set your environment vars as described in the [configuration section](#configuration). -**2. (Optional) Manage Configuration:** -To view or update your configuration in Gemini CLI: +_(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.)_ -- Terminal: `gemini extensions config spanner [setting name] [--scope ]` -- Gemini CLI: `/extensions list` +#### Antigravity CLI -**3. Start the agent:** +**1. Clone the Repo:** ```bash -gemini +git clone --branch 0.3.1 https://github.com/gemini-cli-extensions/spanner.git ``` -_(Tip: Run `/extensions list` to verify your configuration and active extensions.)_ +**2. Install the skills:** -> [!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 ` and `/chat resume `. +Choose a location for the skills: +- **Global (all workspaces):** `~/.gemini/antigravity-cli/skills/` +- **Workspace-specific:** `/.agents/skills/` + +Copy the skill folders from the cloned repository's `skills/` directory to your chosen location: + +```bash +cp -R spanner/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.)_
@@ -183,35 +222,21 @@ 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.)_ +## Installing using [open agent skills tool](https://github.com/vercel-labs/skills) -
-Antigravity +You can install skills using the `npx skills` command. -**1. Clone the Repo:** +Run the following command in your terminal to automatically download and register the skills: ```bash -git clone --branch 0.3.1 https://github.com/gemini-cli-extensions/spanner.git +npx skills add https://github.com/gemini-cli-extensions/spanner/tree/0.3.1 ``` -**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:** `/.agents/skills/` - -Copy the skill folders from the cloned repository's `skills/` directory to your chosen location: - -```bash -cp -R spanner/skills/* ~/.gemini/antigravity/skills/ -``` - -**3. Set env vars:** +**2. Set env vars:** Set your environment vars as described in the [configuration section](#configuration). -_(Tip: Antigravity automatically discovers skills in these directories at the start of a session.)_ - -
- ## Usage Examples