Skip to content

docs: Update README.md #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 19, 2025
Merged

docs: Update README.md #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8741685
docs: Update README.md
averikitsch Sep 19, 2025
367d933
Update README.md
averikitsch Sep 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# Gemini CLI Extension - PostgreSQL

> [!NOTE]
> This extension is currently in beta, and may see breaking changes until the first stable release (v1.0).

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/extension.md).

## 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.
Expand All @@ -12,7 +17,7 @@ This Gemini CLI extension provides a set of tools to interact with [PostgreSQL](

Before you begin, ensure you have the following:

* [Gemini CLI](https://github.com/google-gemini/gemini-cli) installed.
* [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.

Expand Down