Skip to content

Commit 47a10bb

Browse files
averikitschYuan325
andauthored
docs: update readme getting started instructions (#23)
* 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 3b733df commit 47a10bb

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,17 @@ Before you begin, ensure you have the following:
2121
* A running PostgreSQL instance.
2222
* User are granted database-level permissions to execute queries.
2323

24-
## Installation
24+
## Getting Started
25+
26+
### Installation
2527

2628
To install the extension, use the command:
2729

2830
```bash
2931
gemini extensions install https://github.com/gemini-cli-extensions/postgres
3032
```
3133

32-
## Configuration
34+
### Configuration
3335

3436
Set the following environment variables before starting the Gemini CLI:
3537

@@ -39,6 +41,19 @@ Set the following environment variables before starting the Gemini CLI:
3941
* `POSTGRES_USER`: The username for authentication.
4042
* `POSTGRES_PASSWORD`: The password for authentication.
4143

44+
### Start Gemini CLI
45+
46+
To start the Gemini CLI, use the following command:
47+
48+
```bash
49+
gemini
50+
```
51+
52+
> [!WARNING]
53+
> **Changing Instance & Database Connections**
54+
> Currently, the database connection must be configured before starting the Gemini CLI and can not be changed during a session.
55+
> To save and resume conversation history use command: `/chat save <tag>` and `/chat resume <tag>`.
56+
4257
## Usage Examples
4358

4459
Interact with Postgres using natural language right from your IDE:
@@ -67,8 +82,12 @@ Interact with Postgres using natural language right from your IDE:
6782

6883
## Additional Extensions
6984

70-
Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions).
85+
Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions), including:
86+
* [Cloud SQL for PostgreSQL extension](https://github.com/gemini-cli-extensions/cloud-sql-postgresql)
87+
* and more!
7188

7289
## Troubleshooting
7390

74-
* "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.
91+
* "✖ 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.
92+
* "✖ MCP ERROR: Error: spawn /Users/<USER>/.gemini/extensions/postgres/toolbox ENOENT": The Toolbox binary did not download correctly. Ensure you are using Gemini CLI v0.6.0+.
93+
* "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)