From c27e0ee16c2c1821c02a028358a4d89e25404377 Mon Sep 17 00:00:00 2001 From: Averi Kitsch Date: Tue, 14 Oct 2025 16:54:00 -0700 Subject: [PATCH 1/2] docs: update readme with form --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cc60f16..be1190f 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,12 @@ This Gemini CLI extension provides a set of tools to interact with [Cloud SQL for PostgreSQL](https://cloud.google.com/sql/docs/postgres) instances. It allows you to manage your databases, execute queries, explore schemas, and troubleshoot issues directly from the [Gemini CLI](https://google-gemini.github.io/gemini-cli/), using natural language prompts. Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini-cli/blob/main/docs/extensions/index.md). +> [!IMPORTANT] +> **We Want Your Feedback!** +> Please share your thoughts with us by filling out our feedback [form][form]. +> Your input is invaluable and helps us improve the project for everyone. + +[form]: https://docs.google.com/forms/d/e/1FAIpQLSfEGmLR46iipyNTgwTmIDJqzkAwDPXxbocpXpUbHXydiN1RTw/viewform?usp=pp_url&entry.157487=cloud-sql-postgresql ## Why Use the Cloud SQL for PostgreSQL Extension? @@ -14,12 +20,15 @@ Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini * **Full Lifecycle Control:** Manage the entire lifecycle of your database, from creating instances to exploring schemas and running queries. * **Code Generation:** Accelerate development by asking Gemini to generate data classes and other code snippets based on your table schemas. + ## Prerequisites Before you begin, ensure you have the following: * [Gemini CLI](https://github.com/google-gemini/gemini-cli) installed with version **+v0.6.0**. +* Setup Gemini CLI [Authentication](https://github.com/google-gemini/gemini-cli/tree/main?tab=readme-ov-file#-authentication-options). * 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: * Cloud SQL Client (`roles/cloudsql.client`) * Cloud SQL Admin (`roles/cloudsql.admin`) @@ -36,7 +45,7 @@ gemini extensions install https://github.com/gemini-cli-extensions/cloud-sql-pos ### Configuration -Set the following environment variables before starting the Gemini CLI. +Set the following environment variables before starting the Gemini CLI. These variables can be loaded from a `.env` file. This configuration is not required if utilizing the [Admin toolset](#supported-tools). * `CLOUD_SQL_POSTGRES_PROJECT`: The GCP project ID. @@ -81,7 +90,7 @@ Interact with Cloud SQL for PostgreSQL using natural language: ## Supported Tools -* **Admin:** +* **Admin:** * `create_instance`: Use this tool to create an Postgres instance. * `create_user`: Use this tool to create Postgres-BUILT-IN or IAM-based users. * `create_database`: Creates a new database in a Cloud SQL instance. @@ -90,7 +99,7 @@ Interact with Cloud SQL for PostgreSQL using natural language: * `list_databases`: Lists all databases for a Cloud SQL instance. * `wait_for_operation`: Use this tool to poll the operations API until the operation is done. -* **Data:** +* **Data:** * `list_tables`: Use this tool to lists tables in the database. * `execute_sql`: Use this tool to executes a SQL query. * `list_active_queries`: Use this tool to list currently running queries. From 703b2a187ec82d59962f5c1f92e078261217ea9f Mon Sep 17 00:00:00 2001 From: Averi Kitsch Date: Thu, 16 Oct 2025 14:15:49 -0700 Subject: [PATCH 2/2] docs: make env vars copy/paste-able --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index be1190f..f8abb92 100644 --- a/README.md +++ b/README.md @@ -48,13 +48,15 @@ gemini extensions install https://github.com/gemini-cli-extensions/cloud-sql-pos Set the following environment variables before starting the Gemini CLI. These variables can be loaded from a `.env` file. This configuration is not required if utilizing the [Admin toolset](#supported-tools). -* `CLOUD_SQL_POSTGRES_PROJECT`: The GCP project ID. -* `CLOUD_SQL_POSTGRES_REGION`: The region of your Cloud SQL instance. -* `CLOUD_SQL_POSTGRES_INSTANCE`: The ID of your Cloud SQL instance. -* `CLOUD_SQL_POSTGRES_DATABASE`: The name of the database to connect to. -* `CLOUD_SQL_POSTGRES_USER`: (Optional) The database username. -* `CLOUD_SQL_POSTGRES_PASSWORD`: (Optional) The password for the database user. -* `CLOUD_SQL_POSTGRES_IP_TYPE`: (Optional) The IP Type i.e. "PUBLIC", "PRIVATE", or "PSC" (Default: "PUBLIC") +```bash +export CLOUD_SQL_POSTGRES_PROJECT="" +export CLOUD_SQL_POSTGRES_REGION="" +export CLOUD_SQL_POSTGRES_INSTANCE="" +export CLOUD_SQL_POSTGRES_DATABASE="" +export CLOUD_SQL_POSTGRES_USER="" # Optional +export CLOUD_SQL_POSTGRES_PASSWORD="" # Optional +export CLOUD_SQL_POSTGRES_IP_TYPE="PUBLIC" # Optional: `PUBLIC`, `PRIVATE`, `PSC`. Defaults to `PUBLIC`. +``` Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.