You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-9Lines changed: 30 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,7 @@ Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini
12
12
***Seamless Workflow:** As a Google-developed extension, it integrates seamlessly into the Gemini CLI environment. No need to constantly switch contexts for common database tasks.
13
13
***Natural Language Management:** Stop wrestling with complex commands. Explore schemas and query data by describing what you want in plain English.
14
14
***Code Generation:** Accelerate development by asking Gemini to generate data classes and other code snippets based on your table schemas.
15
+
15
16
## Prerequisites
16
17
17
18
Before you begin, ensure you have the following:
@@ -23,15 +24,17 @@ Before you begin, ensure you have the following:
23
24
* Cloud SQL Viewer (`roles/cloudsql.viewer`)
24
25
* Cloud SQL Admin (`roles/cloudsql.admin`)
25
26
26
-
## Installation
27
+
## Getting Started
28
+
29
+
### Installation
27
30
28
-
To install the extension, use the command:
31
+
To install the extension, use the following command before starting the Gemini CLI:
Set the following environment variables before starting the Gemini CLI.
37
40
This configuration is not required if utilizing the [Admin toolset](#supported-tools).
@@ -48,7 +51,20 @@ This configuration is not required if utilizing the [Admin toolset](#supported-t
48
51
Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
49
52
50
53
> [!NOTE]
51
-
> When using private IPs with Cloud SQL for SQL Server, you must use a Virtual Private Cloud (VPC) network.
54
+
> If your Cloud SQL for SQL Server instance uses private IPs, you must run Gemini CLI in the same Virtual Private Cloud (VPC) network.
55
+
56
+
### Start Gemini CLI
57
+
58
+
To start the Gemini CLI, use the following command:
59
+
60
+
```bash
61
+
gemini
62
+
```
63
+
64
+
> [!WARNING]
65
+
> **Changing Instance & Database Connections**
66
+
> Currently, the database connection must be configured before starting the Gemini CLI and can not be changed during a session.
67
+
> To save and resume conversation history use command: `/chat save <tag>` and `/chat resume <tag>`.
52
68
53
69
## Usage Examples
54
70
@@ -67,9 +83,9 @@ Interact with Cloud SQL for SQL Server using natural language:
67
83
## Supported Tools
68
84
69
85
***Admin:**
70
-
* `create_instance`: Use this tool to create an Postgres instance.
71
-
* `create_user`: Use this tool to create Postgres-BUILT-IN or IAM-based users.
72
-
* `get_instance`: Use this tool to get details about an Postgres instance.
86
+
* `create_instance`: Use this tool to create an SQL Server instance.
87
+
* `create_user`: Use this tool to create SQL Server-BUILT-IN or IAM-based users.
88
+
* `get_instance`: Use this tool to get details about an SQL Server instance.
73
89
* `get_user`: Use this tool to get details about a user.
74
90
* `list_instances`: Use this tool to list instances in a given project and location.
75
91
* `list_users`: Use this tool to list users in a given project and location.
@@ -81,8 +97,13 @@ Interact with Cloud SQL for SQL Server using natural language:
81
97
82
98
## Additional Extensions
83
99
84
-
Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions).
100
+
Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions), including:
101
+
*[Generic SQL Server extension](https://github.com/gemini-cli-extensions/sql-server)
102
+
*[Cloud SQL for SQL Server Observability extension](https://github.com/gemini-cli-extensions/cloud-sql-sqlserver-observability)
103
+
* and more!
85
104
86
105
## Troubleshooting
87
106
88
-
* "cannot execute binary file": Ensure the correct binary for your OS/Architecture has been downloaded. See [Installing the server](https://googleapis.github.io/genai-toolbox/getting-started/introduction/#installing-the-server) for more information.
107
+
* "✖ Error during discovery for server: MCP error -32000: Connection closed": The database connection has not been established. Ensure your configuration is set via environment variables.
108
+
* "✖ MCP ERROR: Error: spawn /Users/<USER>/.gemini/extensions/cloud-sql-sqlserver/toolbox ENOENT": The Toolbox binary did not download correctly. Ensure you are using Gemini CLI v0.6.0+.
109
+
* "cannot execute binary file": The Toolbox binary did not download correctly. Ensure the correct binary for your OS/Architecture has been downloaded. See [Installing the server](https://googleapis.github.io/genai-toolbox/getting-started/introduction/#installing-the-server) for more information.
0 commit comments