Skip to content

Commit dcc47c9

Browse files
averikitschYuan325
andauthored
docs: update readme getting started instructions (#26)
* docs: update readme getting started instructions * fix toolset * 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 7038214 commit dcc47c9

File tree

1 file changed

+28
-8
lines changed

1 file changed

+28
-8
lines changed

README.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,17 @@ Before you begin, ensure you have the following:
2424
* Cloud SQL Client (`roles/cloudsql.client`)
2525
* Cloud SQL Admin (`roles/cloudsql.admin`)
2626

27-
## Installation
27+
## Getting Started
28+
29+
### Installation
2830

2931
To install the extension, use the command:
3032

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

35-
## Configuration
37+
### Configuration
3638

3739
Set the following environment variables before starting the Gemini CLI.
3840
This configuration is not required if utilizing the [Admin toolset](#supported-tools).
@@ -48,13 +50,26 @@ This configuration is not required if utilizing the [Admin toolset](#supported-t
4850
Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
4951

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

5570
Interact with Cloud SQL for PostgreSQL using natural language:
5671

57-
* **Provision Infrastructure:**
72+
* **Provision Infrastructure:**
5873
* "Create a new CLoud SQL for Postgres instance named 'e-commerce-prod' in the 'my-gcp-project' project."
5974
* "Create a new user named 'analyst' with read access to all tables."
6075
* **Explore Schemas and Data:**
@@ -69,10 +84,10 @@ Interact with Cloud SQL for PostgreSQL using natural language:
6984
* **Admin:**
7085
* `create_instance`: Use this tool to create an Postgres instance.
7186
* `create_user`: Use this tool to create Postgres-BUILT-IN or IAM-based users.
87+
* `create_database`: Creates a new database in a Cloud SQL instance.
7288
* `get_instance`: Use this tool to get details about an Postgres instance.
73-
* `get_user`: Use this tool to get details about a user.
7489
* `list_instances`: Use this tool to list instances in a given project and location.
75-
* `list_users`: Use this tool to list users in a given project and location.
90+
* `list_databases`: Lists all databases for a Cloud SQL instance.
7691
* `wait_for_operation`: Use this tool to poll the operations API until the operation is done.
7792

7893
* **Data:**
@@ -90,8 +105,13 @@ Interact with Cloud SQL for PostgreSQL using natural language:
90105

91106
## Additional Extensions
92107

93-
Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions), including a generic [PostgreSQL extension](https://github.com/gemini-cli-extensions/postgres).
108+
Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions), including:
109+
* [Generic PostgreSQL extension](https://github.com/gemini-cli-extensions/postgres)
110+
* [Cloud SQL for PostgreSQL Observability extension](https://github.com/gemini-cli-extensions/cloud-sql-postgresql-observability)
111+
* and more!
94112

95113
## Troubleshooting
96114

97-
* "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.
115+
* "✖ 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.
116+
* "✖ MCP ERROR: Error: spawn /Users/<USER>/.gemini/extensions/cloud-sql-postgresql/toolbox ENOENT": The Toolbox binary did not download correctly. Ensure you are using Gemini CLI v0.6.0+.
117+
* "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)