Skip to content

Commit 15107a0

Browse files
authored
docs: update readme with form (#43)
1 parent b34ba64 commit 15107a0

File tree

1 file changed

+22
-14
lines changed

1 file changed

+22
-14
lines changed

README.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,28 @@
66
This Gemini CLI extension provides a set of tools to interact with [PostgreSQL](https://www.postgresql.org/docs/) instances. It allows you to manage your databases, execute queries, and explore schemas directly from the [Gemini CLI](https://google-gemini.github.io/gemini-cli/), using natural language prompts.
77

88
Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini-cli/blob/main/docs/extensions/index.md).
9+
> [!IMPORTANT]
10+
> **We Want Your Feedback!**
11+
> Please share your thoughts with us by filling out our feedback [form][form].
12+
> Your input is invaluable and helps us improve the project for everyone.
13+
14+
[form]: https://docs.google.com/forms/d/e/1FAIpQLSfEGmLR46iipyNTgwTmIDJqzkAwDPXxbocpXpUbHXydiN1RTw/viewform?usp=pp_url&entry.157487=postgres
915

1016
## Why Use the Postgres Extension?
1117

12-
* **Natural Language Management:** Stop wrestling with complex commands. Explore schemas and query data by describing what you want in plain English.
13-
* **Seamless Workflow:** Stay in your CLI. No need to constantly switch contexts to the GCP console for common database tasks.
14-
* **Code Generation:** Accelerate development by asking Gemini to generate data classes and other code snippets based on your table schemas.
18+
* **Natural Language Management:** Stop wrestling with complex commands. Explore schemas and query data by describing what you want in plain English.
19+
* **Seamless Workflow:** Stay in your CLI. No need to constantly switch contexts to the GCP console for common database tasks.
20+
* **Code Generation:** Accelerate development by asking Gemini to generate data classes and other code snippets based on your table schemas.
21+
1522

1623
## Prerequisites
1724

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

20-
* [Gemini CLI](https://github.com/google-gemini/gemini-cli) installed with version **+v0.6.0**.
21-
* A running PostgreSQL instance.
22-
* User are granted database-level permissions to execute queries.
27+
* [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).
29+
* A running PostgreSQL instance.
30+
* User are granted database-level permissions to execute queries.
2331

2432
## Getting Started
2533

@@ -33,13 +41,13 @@ gemini extensions install https://github.com/gemini-cli-extensions/postgres
3341

3442
### Configuration
3543

36-
Set the following environment variables before starting the Gemini CLI:
44+
Set the following environment variables before starting the Gemini CLI. These variables can be loaded from a `.env` file.
3745

38-
* `POSTGRES_HOST`: The hostname or IP address of the PostgreSQL server.
39-
* `POSTGRES_PORT`: The port number of the PostgreSQL server.
40-
* `POSTGRES_DATABASE`: The name of the database to connect to.
41-
* `POSTGRES_USER`: The username for authentication.
42-
* `POSTGRES_PASSWORD`: The password for authentication.
46+
* `POSTGRES_HOST`: The hostname or IP address of the PostgreSQL server.
47+
* `POSTGRES_PORT`: The port number of the PostgreSQL server.
48+
* `POSTGRES_DATABASE`: The name of the database to connect to.
49+
* `POSTGRES_USER`: The username for authentication.
50+
* `POSTGRES_PASSWORD`: The password for authentication.
4351

4452
### Start Gemini CLI
4553

@@ -58,12 +66,12 @@ gemini
5866

5967
Interact with Postgres using natural language right from your IDE:
6068

61-
* **Explore Schemas and Data:**
69+
* **Explore Schemas and Data:**
6270
* "Show me all tables in the 'orders' database."
6371
* "What are the columns in the 'products' table?"
6472
* "How many orders were placed in the last 30 days, and what were the top 5 most purchased items?"
6573

66-
* **Generate Code:**
74+
* **Generate Code:**
6775
* "Generate a Python dataclass to represent the 'customers' table."
6876

6977
## Supported Tools

0 commit comments

Comments
 (0)