diff --git a/README.md b/README.md index 8a9f86d..23e68fd 100644 --- a/README.md +++ b/README.md @@ -6,20 +6,28 @@ 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. Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini-cli/blob/main/docs/extensions/index.md). +> [!IMPORTANT] +> **We Want Your Feedback!** +> Please share your thoughts with us by filling out our feedback [form][form]. +> Your input is invaluable and helps us improve the project for everyone. + +[form]: https://docs.google.com/forms/d/e/1FAIpQLSfEGmLR46iipyNTgwTmIDJqzkAwDPXxbocpXpUbHXydiN1RTw/viewform?usp=pp_url&entry.157487=postgres ## Why Use the Postgres Extension? -* **Natural Language Management:** Stop wrestling with complex commands. Explore schemas and query data by describing what you want in plain English. -* **Seamless Workflow:** Stay in your CLI. No need to constantly switch contexts to the GCP console for common database tasks. -* **Code Generation:** Accelerate development by asking Gemini to generate data classes and other code snippets based on your table schemas. +* **Natural Language Management:** Stop wrestling with complex commands. Explore schemas and query data by describing what you want in plain English. +* **Seamless Workflow:** Stay in your CLI. No need to constantly switch contexts to the GCP console for common database tasks. +* **Code Generation:** Accelerate development by asking Gemini to generate data classes and other code snippets based on your table schemas. + ## Prerequisites Before you begin, ensure you have the following: -* [Gemini CLI](https://github.com/google-gemini/gemini-cli) installed with version **+v0.6.0**. -* A running PostgreSQL instance. -* User are granted database-level permissions to execute queries. +* [Gemini CLI](https://github.com/google-gemini/gemini-cli) installed with version **+v0.6.0**. +* Setup Gemini CLI [Authentication](https://github.com/google-gemini/gemini-cli/tree/main?tab=readme-ov-file#-authentication-options). +* A running PostgreSQL instance. +* User are granted database-level permissions to execute queries. ## Getting Started @@ -33,13 +41,13 @@ gemini extensions install https://github.com/gemini-cli-extensions/postgres ### Configuration -Set the following environment variables before starting the Gemini CLI: +Set the following environment variables before starting the Gemini CLI. These variables can be loaded from a `.env` file. -* `POSTGRES_HOST`: The hostname or IP address of the PostgreSQL server. -* `POSTGRES_PORT`: The port number of the PostgreSQL server. -* `POSTGRES_DATABASE`: The name of the database to connect to. -* `POSTGRES_USER`: The username for authentication. -* `POSTGRES_PASSWORD`: The password for authentication. +* `POSTGRES_HOST`: The hostname or IP address of the PostgreSQL server. +* `POSTGRES_PORT`: The port number of the PostgreSQL server. +* `POSTGRES_DATABASE`: The name of the database to connect to. +* `POSTGRES_USER`: The username for authentication. +* `POSTGRES_PASSWORD`: The password for authentication. ### Start Gemini CLI @@ -58,12 +66,12 @@ gemini Interact with Postgres using natural language right from your IDE: -* **Explore Schemas and Data:** +* **Explore Schemas and Data:** * "Show me all tables in the 'orders' database." * "What are the columns in the 'products' table?" * "How many orders were placed in the last 30 days, and what were the top 5 most purchased items?" -* **Generate Code:** +* **Generate Code:** * "Generate a Python dataclass to represent the 'customers' table." ## Supported Tools