From ffeb070d48c2f0005f6af89f97599323ac645cd2 Mon Sep 17 00:00:00 2001 From: Averi Kitsch Date: Wed, 28 Jan 2026 16:18:07 -0800 Subject: [PATCH 1/2] docs: add configuration instructions --- README.md | 34 +++++++++++++++++++++++++++++----- 1 file changed, 29 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b0b6fb3..76211be 100644 --- a/README.md +++ b/README.md @@ -45,8 +45,32 @@ gemini extensions install https://github.com/gemini-cli-extensions/cloud-sql-mys ### Configuration -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). +You will be prompted to configure the following settings during installation. These settings are saved in an `.env` file within the extension's directory. + +* `CLOUD_SQL_MYSQL_PROJECT`: The GCP project ID. +* `CLOUD_SQL_MYSQL_REGION`: The region of your Cloud SQL instance. +* `CLOUD_SQL_MYSQL_INSTANCE`: The ID of your Cloud SQL instance. +* `CLOUD_SQL_MYSQL_DATABASE`: The name of the database to connect to. +* `CLOUD_SQL_MYSQL_USER`: (Optional) The database username. Defaults to the active IAM user. +* `CLOUD_SQL_MYSQL_PASSWORD`: (Optional) The password for the database user. +* `CLOUD_SQL_MYSQL_IP_TYPE`: (Optional) Type of the IP address: `PUBLIC`, `PRIVATE`, or `PSC`. Defaults to `PUBLIC`. + +> [!NOTE] +> This configuration is primarily for the Data Plane tools (querying). The Admin toolset does not strictly require these to be pre-set if you provide them in your prompts, but it is recommended for a smoother experience. + +To view or update your configuration: + +**List Settings:** +* Terminal: `gemini extensions list` +* Gemini CLI: `/extensions list` + +**Update Settings:** +* Terminal: `gemini extensions config cloud-sql-mysql [setting name] [--scope ]` + * `setting name`: (Optional) The single setting to configure. + * `scope`: (Optional) The scope of the setting in (`user` or `workspace`). Defaults to `user`. +* Currently, you must restart the Gemini CLI for changes to take effect. We recommend using `gemini --resume` to resume your session. + +Alternatively, you can manually set these environment variables before starting the Gemini CLI: ```bash export CLOUD_SQL_MYSQL_PROJECT="" @@ -58,10 +82,10 @@ export CLOUD_SQL_MYSQL_PASSWORD="" # Optional, defaults export CLOUD_SQL_MYSQL_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. - > [!NOTE] -> If your Cloud SQL for MySQL instance uses private IPs, you must run Gemini CLI in the same Virtual Private Cloud (VPC) network. +> * Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment. +> * If your Cloud SQL for MySQL instance uses private IPs, you must run Gemini CLI in the same Virtual Private Cloud (VPC) network. +> * See [Troubleshooting](#troubleshooting) for debugging your configuration. ### Start Gemini CLI From 2f5a76564fadc22ffcd1b9e6a344beb897dc0673 Mon Sep 17 00:00:00 2001 From: Averi Kitsch Date: Fri, 30 Jan 2026 12:01:05 -0800 Subject: [PATCH 2/2] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 76211be..1f7ec88 100644 --- a/README.md +++ b/README.md @@ -49,10 +49,10 @@ You will be prompted to configure the following settings during installation. Th * `CLOUD_SQL_MYSQL_PROJECT`: The GCP project ID. * `CLOUD_SQL_MYSQL_REGION`: The region of your Cloud SQL instance. -* `CLOUD_SQL_MYSQL_INSTANCE`: The ID of your Cloud SQL instance. +* `CLOUD_SQL_MYSQL_INSTANCE`: The name of your Cloud SQL instance. * `CLOUD_SQL_MYSQL_DATABASE`: The name of the database to connect to. * `CLOUD_SQL_MYSQL_USER`: (Optional) The database username. Defaults to the active IAM user. -* `CLOUD_SQL_MYSQL_PASSWORD`: (Optional) The password for the database user. +* `CLOUD_SQL_MYSQL_PASSWORD`: (Optional) The password for the database user. Required if using CLOUD_SQL_MYSQL_USER. Defaults to the active IAM user. * `CLOUD_SQL_MYSQL_IP_TYPE`: (Optional) Type of the IP address: `PUBLIC`, `PRIVATE`, or `PSC`. Defaults to `PUBLIC`. > [!NOTE]