From f02dfd1b309bc263109c3faf3d8cd0b11d413979 Mon Sep 17 00:00:00 2001 From: Averi Kitsch Date: Tue, 14 Oct 2025 16:54:12 -0700 Subject: [PATCH] docs: update readme with form --- README.md | 54 ++++++++++++------------------------------------------ 1 file changed, 12 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 7b5bdf5..1f080c9 100644 --- a/README.md +++ b/README.md @@ -13,12 +13,21 @@ Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini * **Natural Language Management:** Stop wrestling with complex commands. Explore schemas and query data by describing what you want in plain English. * **Code Generation:** Accelerate development by asking Gemini to generate data classes and other code snippets based on your table schemas. +> [!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-sqlserver + ## 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 Viewer (`roles/cloudsql.viewer`) @@ -36,7 +45,7 @@ gemini extensions install https://github.com/gemini-cli-extensions/cloud-sql-sql ### 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_MSSQL_PROJECT`: The GCP project ID. @@ -66,45 +75,6 @@ gemini > Currently, the database connection must be configured before starting the Gemini CLI and can not be changed during a session. > To save and resume conversation history use command: `/chat save ` and `/chat resume `. -### Start Gemini CLI - -To start the Gemini CLI, use the following command: - -```bash -gemini -``` - -> [!WARNING] -> **Changing Instance & Database Connections** -> Currently, the database connection must be configured before starting the Gemini CLI and can not be changed during a session. -> To save and resume conversation history use command: `/chat save ` and `/chat resume `. - -### Start Gemini CLI - -To start the Gemini CLI, use the following command: - -```bash -gemini -``` - -> [!WARNING] -> **Changing Instance & Database Connections** -> Currently, the database connection must be configured before starting the Gemini CLI and can not be changed during a session. -> To save and resume conversation history use command: `/chat save ` and `/chat resume `. - -### Start Gemini CLI - -To start the Gemini CLI, use the following command: - -```bash -gemini -``` - -> [!WARNING] -> **Changing Instance & Database Connections** -> Currently, the database connection must be configured before starting the Gemini CLI and can not be changed during a session. -> To save and resume conversation history use command: `/chat save ` and `/chat resume `. - ## Usage Examples Interact with Cloud SQL for SQL Server using natural language: @@ -121,7 +91,7 @@ Interact with Cloud SQL for SQL Server using natural language: ## Supported Tools -* **Admin:** +* **Admin:** * `create_instance`: Use this tool to create an SQL Server instance. * `create_user`: Use this tool to create SQL Server-BUILT-IN or IAM-based users. * `get_instance`: Use this tool to get details about an SQL Server instance. @@ -130,7 +100,7 @@ Interact with Cloud SQL for SQL Server using natural language: * `list_users`: Use this tool to list users in a given project and location. * `wait_for_operation`: Use this tool to poll the operations API until the operation is done. -* **Data:** +* **Data:** * `list_tables`: Use this tool to list tables and descriptions. * `execute_sql`: Use this tool to execute any SQL statement.