Skip to content

Commit 47692d2

Browse files
authored
docs: update readme getting started instructions (#28)
1 parent 782e50b commit 47692d2

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini
1212
* **Seamless Workflow:** As a Google-developed extension, it integrates seamlessly into the Gemini CLI environment. No need to constantly switch contexts for common database tasks.
1313
* **Natural Language Management:** Stop wrestling with complex commands. Explore schemas and query data by describing what you want in plain English.
1414
* **Code Generation:** Accelerate development by asking Gemini to generate data classes and other code snippets based on your table schemas.
15+
1516
## Prerequisites
1617

1718
Before you begin, ensure you have the following:
@@ -27,7 +28,7 @@ Before you begin, ensure you have the following:
2728

2829
### Installation
2930

30-
To install the extension, use the command:
31+
To install the extension, use the following command before starting the Gemini CLI:
3132

3233
```bash
3334
gemini extensions install https://github.com/gemini-cli-extensions/cloud-sql-sqlserver
@@ -50,7 +51,20 @@ This configuration is not required if utilizing the [Admin toolset](#supported-t
5051
Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
5152

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

@@ -82,9 +96,9 @@ Interact with Cloud SQL for SQL Server using natural language:
8296
## Supported Tools
8397

8498
* **Admin:**
85-
* `create_instance`: Use this tool to create an Postgres instance.
86-
* `create_user`: Use this tool to create Postgres-BUILT-IN or IAM-based users.
87-
* `get_instance`: Use this tool to get details about an Postgres instance.
99+
* `create_instance`: Use this tool to create an SQL Server instance.
100+
* `create_user`: Use this tool to create SQL Server-BUILT-IN or IAM-based users.
101+
* `get_instance`: Use this tool to get details about an SQL Server instance.
88102
* `get_user`: Use this tool to get details about a user.
89103
* `list_instances`: Use this tool to list instances in a given project and location.
90104
* `list_users`: Use this tool to list users in a given project and location.
@@ -96,7 +110,10 @@ Interact with Cloud SQL for SQL Server using natural language:
96110

97111
## Additional Extensions
98112

99-
Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions).
113+
Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions), including:
114+
* [Generic SQL Server extension](https://github.com/gemini-cli-extensions/sql-server)
115+
* [Cloud SQL for SQL Server Observability extension](https://github.com/gemini-cli-extensions/cloud-sql-sqlserver-observability)
116+
* and more!
100117

101118
## Troubleshooting
102119

0 commit comments

Comments
 (0)