Skip to content

Commit b3a13c2

Browse files
averikitschYuan325
andauthored
docs: update readme getting started instructions (#24)
* 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 810ec9d commit b3a13c2

1 file changed

Lines changed: 22 additions & 8 deletions

File tree

README.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,17 @@ Before you begin, ensure you have the following:
2323
* BigQuery User (`roles/bigquery.user`) (for executing queries and view metadata)
2424
* Gemini for Google Cloud (`roles/cloudaicompanion.user`) (to use the conversational analytics API)
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/bigquery-conversational-analytics
3234
```
3335

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

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

@@ -41,25 +43,37 @@ Set the following environment variables before starting the Gemini CLI:
4143

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

44-
## **Usage Examples**
46+
### Start Gemini CLI
47+
48+
To start the Gemini CLI, use the following command:
49+
50+
```bash
51+
gemini
52+
```
53+
54+
## Usage Examples
4555

4656
Interact with BigQuery using natural language right from your IDE:
4757

48-
* **Ask for insights**
58+
* Ask for insights
4959

5060
* Using the tables under bigquery-public-data.google\_analytics\_sample , tell me the channels I should focus on and why?
5161

52-
## **Supported Tools**
62+
## Supported Tools
5363

5464
This extension provides a comprehensive set of tools:
5565

56-
* `ask_data_insights`: Executes a SQL query.
66+
* `ask_data_insights`: Perform data analysis, get insights, or answer complex questions about the contents of specific BigQuery tables.
5767
* `search_catalog`: Find BigQuery tables relevant to users, natural language query.
5868

5969
## Additional Extensions
6070

61-
Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions).
71+
Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions), including:
72+
* [BigQuery Data Analytics](https://github.com/gemini-cli-extensions/bigquery-data-analytics)
73+
* and more!
6274

6375
## Troubleshooting
6476

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