diff --git a/.lycheeignore b/.lycheeignore index e25be66..c3fe010 100644 --- a/.lycheeignore +++ b/.lycheeignore @@ -1 +1,2 @@ https://github.com/gemini-cli-extensions/cloud-sql-postgresql/compare/ +https://www.npmjs.com/package/skills diff --git a/README.md b/README.md index 4177f63..4041cd5 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 [Cloud SQL for PostgreSQL](https://cloud.google.com/sql/docs/postgres) 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 [Cloud SQL for PostgreSQL](https://cloud.google.com/sql/docs/postgres) 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 [Cloud SQL for P - [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 [Cloud SQL for P 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 **Cloud SQL Admin API** enabled. - Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment. - IAM Permissions: @@ -83,34 +83,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. -**1. Install the extension:** +> [!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: +> +> ```bash +> agy plugin import gemini +> ``` +> See the [official Gemini CLI → Antigravity migration guide](https://antigravity.google/docs/gcli-migration) for details on plugins, context files (`GEMINI.md` / `AGENTS.md`), and MCP server config differences (note: Antigravity uses `mcp_config.json` and the `serverUrl` field instead of `url`). + +#### Antigravity 2.0 (IDE) + +**1. Clone the Repo:** ```bash -gemini extensions install https://github.com/gemini-cli-extensions/cloud-sql-postgresql +git clone --branch 0.4.0 https://github.com/gemini-cli-extensions/cloud-sql-postgresql.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:** `/.agents/skills/` + +Copy the skill folders from the cloned repository's `skills/` directory to your chosen location: + +```bash +cp -R cloud-sql-postgresql/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.4.0 https://github.com/gemini-cli-extensions/cloud-sql-postgresql.git +``` -**2. (Optional) Manage Configuration:** -To view or update your configuration in Gemini CLI: +**2. Install the skills:** -- Terminal: `gemini extensions config cloud-sql-postgresql [setting name] [--scope ]` -- Gemini CLI: `/extensions list` +Choose a location for the skills: +- **Global (all workspaces):** `~/.gemini/antigravity-cli/skills/` +- **Workspace-specific:** `/.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 cloud-sql-postgresql/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 ` and `/chat resume `. +_(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.)_
@@ -184,33 +223,20 @@ _(Tip: Run `codex plugin list` or use the `/plugins` interactive menu to verify -
-Antigravity +## Installing using skills package. -**1. Clone the Repo:** +You can install skills using the `npx skills` command. -```bash -git clone --branch 0.4.0 https://github.com/gemini-cli-extensions/cloud-sql-postgresql.git -``` - -**2. Install the 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: +Run the following command in your terminal to automatically download and register the skills: ```bash -cp -R cloud-sql-postgresql/skills/* ~/.gemini/antigravity/skills/ +npx skills add https://github.com/gemini-cli-extensions/cloud-sql-postgresql/tree/0.4.0 ``` -**3. Set env vars:** -Set your environment vars as described in the [configuration section](#configuration). +For detailed info check out the [Skills npm package](https://www.npmjs.com/package/skills). -_(Tip: Antigravity automatically discovers skills in these directories at the start of a session.)_ - -
+**2. Set env vars:** +Set your environment vars as described in the [configuration section](#configuration).