Skip to content

Commit 5c22e09

Browse files
averikitschYuan325
andauthored
docs: update readme getting started instructions (#27)
* 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 01670d2 commit 5c22e09

1 file changed

Lines changed: 19 additions & 6 deletions

File tree

README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,19 @@ Before you begin, ensure you have the following:
2020
* [Gemini CLI](https://github.com/google-gemini/gemini-cli) installed with version **+v0.6.0**.
2121
* A Google Cloud project with the **BigQuery API** enabled.
2222
* IAM Permissions:
23-
* BigQuery User (`roles/bigquery.user`) (for executing queries and view
24-
metadata)
23+
* BigQuery User (`roles/bigquery.user`)
2524

26-
## Installation
25+
## Getting Started
26+
27+
### Installation
2728

2829
To install the extension, use the command:
2930

3031
```bash
3132
gemini extensions install https://github.com/gemini-cli-extensions/bigquery-data-analytics
3233
```
3334

34-
## Configuration
35+
### Configuration
3536

3637
Set the following environment variables before starting the Gemini CLI:
3738

@@ -41,6 +42,14 @@ Set the following environment variables before starting the Gemini CLI:
4142

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

45+
### Start Gemini CLI
46+
47+
To start the Gemini CLI, use the following command:
48+
49+
```bash
50+
gemini
51+
```
52+
4453
## Usage Examples
4554

4655
Interact with BigQuery using natural language right from your IDE:
@@ -70,8 +79,12 @@ This extension provides a comprehensive set of tools:
7079

7180
## Additional Extensions
7281

73-
Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions).
82+
Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions), including:
83+
* [BigQuery Conversational Analytics](https://github.com/gemini-cli-extensions/bigquery-conversational-analytics)
84+
* and more!
7485

7586
## Troubleshooting
7687

77-
* "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.
88+
* "✖ 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.
89+
* "✖ MCP ERROR: Error: spawn /Users/<USER>/.gemini/extensions/bigquery-data-analytics/toolbox ENOENT": The Toolbox binary did not download correctly. Ensure you are using Gemini CLI v0.6.0+.
90+
* "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)