Skip to content

Commit 127a4aa

Browse files
averikitschYuan325
andauthored
docs: update readme getting started instructions (#29)
* docs: update readme getting started instructions * Update README.md Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com> --------- Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com>
1 parent 361b241 commit 127a4aa

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

README.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,19 @@ Before you begin, ensure you have the following:
2323
* Cloud SQL Viewer (`roles/cloudsql.viewer`)
2424
* Cloud SQL Admin (`roles/cloudsql.admin`)
2525

26-
## Installation
26+
## Getting Started
27+
28+
### Installation
2729

2830
To install the extension, use the command:
2931

3032
```bash
3133
gemini extensions install https://github.com/gemini-cli-extensions/cloud-sql-mysql
3234
```
3335

34-
## Configuration
36+
### Configuration
3537

36-
Set the following environment variables before starting the Gemini CLI.
38+
Set the following environment variables before starting the Gemini CLI.
3739
This configuration is not required if utilizing the [Admin toolset](#supported-tools).
3840

3941
* `CLOUD_SQL_MYSQL_PROJECT`: The GCP project ID.
@@ -47,7 +49,20 @@ This configuration is not required if utilizing the [Admin toolset](#supported-t
4749
Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
4850

4951
> [!NOTE]
50-
> When using private IPs with Cloud SQL for MySQL, you must use a Virtual Private Cloud (VPC) network.
52+
> If your Cloud SQL for MySQL instance uses private IPs, you must run Gemini CLI in the same Virtual Private Cloud (VPC) network.
53+
54+
### Start Gemini CLI
55+
56+
To start the Gemini CLI, use the following command:
57+
58+
```bash
59+
gemini
60+
```
61+
62+
> [!WARNING]
63+
> **Changing Instance & Database Connections**
64+
> Currently, the database connection must be configured before starting the Gemini CLI and can not be changed during a session.
65+
> To save and resume conversation history use command: `/chat save <tag>` and `/chat resume <tag>`.
5166
5267
## Usage Examples
5368

@@ -84,8 +99,13 @@ Interact with MySQL using natural language:
8499

85100
## Additional Extensions
86101

87-
Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions).
102+
Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions), including:
103+
* [Generic MySQL extension](https://github.com/gemini-cli-extensions/mysql)
104+
* [Cloud SQL for MySQL Observability extension](https://github.com/gemini-cli-extensions/cloud-sql-mysql-observability)
105+
* and more!
88106

89107
## Troubleshooting
90108

91-
* "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.
109+
* "✖ 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.
110+
* "✖ MCP ERROR: Error: spawn /Users/<USER>/.gemini/extensions/cloud-sql-mysql/toolbox ENOENT": The Toolbox binary did not download correctly. Ensure you are using Gemini CLI v0.6.0+.
111+
* "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

Comments
 (0)