Skip to content

Commit 335060b

Browse files
authored
docs: update readme with form (#47)
1 parent ae6927b commit 335060b

File tree

1 file changed

+12
-42
lines changed

1 file changed

+12
-42
lines changed

README.md

Lines changed: 12 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,21 @@ Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini
1313
* **Natural Language Management:** Stop wrestling with complex commands. Explore schemas and query data by describing what you want in plain English.
1414
* **Code Generation:** Accelerate development by asking Gemini to generate data classes and other code snippets based on your table schemas.
1515

16+
> [!IMPORTANT]
17+
> **We Want Your Feedback!**
18+
> Please share your thoughts with us by filling out our feedback [form][form].
19+
> Your input is invaluable and helps us improve the project for everyone.
20+
21+
[form]: https://docs.google.com/forms/d/e/1FAIpQLSfEGmLR46iipyNTgwTmIDJqzkAwDPXxbocpXpUbHXydiN1RTw/viewform?usp=pp_url&entry.157487=cloud-sql-sqlserver
22+
1623
## Prerequisites
1724

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

2027
* [Gemini CLI](https://github.com/google-gemini/gemini-cli) installed with version **+v0.6.0**.
28+
* Setup Gemini CLI [Authentication](https://github.com/google-gemini/gemini-cli/tree/main?tab=readme-ov-file#-authentication-options).
2129
* A Google Cloud project with the **Cloud SQL Admin API** enabled.
30+
* Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
2231
* IAM Permissions:
2332
* Cloud SQL Client (`roles/cloudsql.client`)
2433
* Cloud SQL Viewer (`roles/cloudsql.viewer`)
@@ -36,7 +45,7 @@ gemini extensions install https://github.com/gemini-cli-extensions/cloud-sql-sql
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_MSSQL_PROJECT`: The GCP project ID.
@@ -66,45 +75,6 @@ gemini
6675
> Currently, the database connection must be configured before starting the Gemini CLI and can not be changed during a session.
6776
> To save and resume conversation history use command: `/chat save <tag>` and `/chat resume <tag>`.
6877
69-
### Start Gemini CLI
70-
71-
To start the Gemini CLI, use the following command:
72-
73-
```bash
74-
gemini
75-
```
76-
77-
> [!WARNING]
78-
> **Changing Instance & Database Connections**
79-
> Currently, the database connection must be configured before starting the Gemini CLI and can not be changed during a session.
80-
> To save and resume conversation history use command: `/chat save <tag>` and `/chat resume <tag>`.
81-
82-
### Start Gemini CLI
83-
84-
To start the Gemini CLI, use the following command:
85-
86-
```bash
87-
gemini
88-
```
89-
90-
> [!WARNING]
91-
> **Changing Instance & Database Connections**
92-
> Currently, the database connection must be configured before starting the Gemini CLI and can not be changed during a session.
93-
> To save and resume conversation history use command: `/chat save <tag>` and `/chat resume <tag>`.
94-
95-
### Start Gemini CLI
96-
97-
To start the Gemini CLI, use the following command:
98-
99-
```bash
100-
gemini
101-
```
102-
103-
> [!WARNING]
104-
> **Changing Instance & Database Connections**
105-
> Currently, the database connection must be configured before starting the Gemini CLI and can not be changed during a session.
106-
> To save and resume conversation history use command: `/chat save <tag>` and `/chat resume <tag>`.
107-
10878
## Usage Examples
10979

11080
Interact with Cloud SQL for SQL Server using natural language:
@@ -121,7 +91,7 @@ Interact with Cloud SQL for SQL Server using natural language:
12191

12292
## Supported Tools
12393

124-
* **Admin:**
94+
* **Admin:**
12595
* `create_instance`: Use this tool to create an SQL Server instance.
12696
* `create_user`: Use this tool to create SQL Server-BUILT-IN or IAM-based users.
12797
* `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:
130100
* `list_users`: Use this tool to list users in a given project and location.
131101
* `wait_for_operation`: Use this tool to poll the operations API until the operation is done.
132102

133-
* **Data:**
103+
* **Data:**
134104
* `list_tables`: Use this tool to list tables and descriptions.
135105
* `execute_sql`: Use this tool to execute any SQL statement.
136106

0 commit comments

Comments
 (0)