Skip to content

Commit 167d9e7

Browse files
averikitschYuan325
andauthored
docs: update readme getting started instructions (#29)
* 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 056809d commit 167d9e7

1 file changed

Lines changed: 20 additions & 3 deletions

File tree

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,17 @@ Before you begin, ensure you have the following:
2323
* Cloud Spanner Database Reader (`roles/spanner.databaseReader`)
2424
* Cloud Spanner Database User (`roles/spanner.databaseUser`)
2525

26-
## Installation
26+
## Getting Started
27+
28+
### Installation
2729

2830
To install the extension, use the command:
2931

3032
```bash
3133
gemini extensions install https://github.com/gemini-cli-extensions/spanner
3234
```
3335

34-
## Configuration
36+
### Configuration
3537

3638
Set the following environment variables before starting the Gemini CLI:
3739

@@ -42,6 +44,19 @@ Set the following environment variables before starting the Gemini CLI:
4244

4345
Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
4446

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

4762
* **Explore Schemas and Data:**
@@ -64,4 +79,6 @@ Find additional extensions to support your entire software development lifecycle
6479

6580
## Troubleshooting
6681

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