Skip to content

Commit 0ab1449

Browse files
authored
docs: update readme with form (gemini-cli-extensions#49)
1 parent 47feef9 commit 0ab1449

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66
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.
77

88
Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini-cli/blob/main/docs/extensions/index.md).
9+
> [!IMPORTANT]
10+
> **We Want Your Feedback!**
11+
> Please share your thoughts with us by filling out our feedback [form][form].
12+
> Your input is invaluable and helps us improve the project for everyone.
13+
14+
[form]: https://docs.google.com/forms/d/e/1FAIpQLSfEGmLR46iipyNTgwTmIDJqzkAwDPXxbocpXpUbHXydiN1RTw/viewform?usp=pp_url&entry.157487=cloud-sql-postgresql
915

1016
## Why Use the Cloud SQL for PostgreSQL Extension?
1117

@@ -14,12 +20,15 @@ Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini
1420
* **Full Lifecycle Control:** Manage the entire lifecycle of your database, from creating instances to exploring schemas and running queries.
1521
* **Code Generation:** Accelerate development by asking Gemini to generate data classes and other code snippets based on your table schemas.
1622

23+
1724
## Prerequisites
1825

1926
Before you begin, ensure you have the following:
2027

2128
* [Gemini CLI](https://github.com/google-gemini/gemini-cli) installed with version **+v0.6.0**.
29+
* Setup Gemini CLI [Authentication](https://github.com/google-gemini/gemini-cli/tree/main?tab=readme-ov-file#-authentication-options).
2230
* A Google Cloud project with the **Cloud SQL Admin API** enabled.
31+
* Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
2332
* IAM Permissions:
2433
* Cloud SQL Client (`roles/cloudsql.client`)
2534
* Cloud SQL Admin (`roles/cloudsql.admin`)
@@ -36,7 +45,7 @@ gemini extensions install https://github.com/gemini-cli-extensions/cloud-sql-pos
3645

3746
### Configuration
3847

39-
Set the following environment variables before starting the Gemini CLI.
48+
Set the following environment variables before starting the Gemini CLI. These variables can be loaded from a `.env` file.
4049
This configuration is not required if utilizing the [Admin toolset](#supported-tools).
4150

4251
* `CLOUD_SQL_POSTGRES_PROJECT`: The GCP project ID.
@@ -81,7 +90,7 @@ Interact with Cloud SQL for PostgreSQL using natural language:
8190

8291
## Supported Tools
8392

84-
* **Admin:**
93+
* **Admin:**
8594
* `create_instance`: Use this tool to create an Postgres instance.
8695
* `create_user`: Use this tool to create Postgres-BUILT-IN or IAM-based users.
8796
* `create_database`: Creates a new database in a Cloud SQL instance.
@@ -90,7 +99,7 @@ Interact with Cloud SQL for PostgreSQL using natural language:
9099
* `list_databases`: Lists all databases for a Cloud SQL instance.
91100
* `wait_for_operation`: Use this tool to poll the operations API until the operation is done.
92101

93-
* **Data:**
102+
* **Data:**
94103
* `list_tables`: Use this tool to lists tables in the database.
95104
* `execute_sql`: Use this tool to executes a SQL query.
96105
* `list_active_queries`: Use this tool to list currently running queries.

0 commit comments

Comments
 (0)