From 19b10fd4b7eb96a1d1c42b213d61f834db9b911c Mon Sep 17 00:00:00 2001 From: Averi Kitsch Date: Fri, 26 Sep 2025 14:44:21 -0700 Subject: [PATCH 1/2] docs: update readme getting started instructions --- README.md | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 56f2d9d..c59ca09 100644 --- a/README.md +++ b/README.md @@ -20,10 +20,11 @@ Before you begin, ensure you have the following: * [Gemini CLI](https://github.com/google-gemini/gemini-cli) installed with version **+v0.6.0**. * A Google Cloud project with the **BigQuery API** enabled. * IAM Permissions: - * BigQuery User (`roles/bigquery.user`) (for executing queries and view - metadata) + * BigQuery User (`roles/bigquery.user`) -## Installation +## Getting Started + +### Installation To install the extension, use the command: @@ -31,7 +32,7 @@ To install the extension, use the command: gemini extensions install https://github.com/gemini-cli-extensions/bigquery-data-analytics ``` -## Configuration +### Configuration Set the following environment variables before starting the Gemini CLI: @@ -41,6 +42,14 @@ Set the following environment variables before starting the Gemini CLI: Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment. +### Start Gemini CLI + +To start the Gemini CLI, use the following command: + +```bash +gemini +``` + ## Usage Examples Interact with BigQuery using natural language right from your IDE: @@ -70,8 +79,12 @@ This extension provides a comprehensive set of tools: ## Additional Extensions -Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions). +Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions), including: +* [BigQuery Conversational Analytics](https://github.com/gemini-cli-extensions/bigquery-conversational-analytics) +* and more! ## Troubleshooting -* "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. +* "✖ 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. +* "✖ MCP ERROR: Error: spawn /Users//.gemini/extensions/cloud-sql-sqlserver/toolbox ENOENT": The Toolbox binary did not download correctly. Ensure you are using Gemini CLI v0.6.0+. +* "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. \ No newline at end of file From f386c89af629b6d7d2097328c11400365b0c1d1e Mon Sep 17 00:00:00 2001 From: Averi Kitsch Date: Tue, 30 Sep 2025 08:30:43 -0700 Subject: [PATCH 2/2] Update README.md Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c59ca09..004ab95 100644 --- a/README.md +++ b/README.md @@ -86,5 +86,5 @@ Find additional extensions to support your entire software development lifecycle ## Troubleshooting * "✖ 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. -* "✖ MCP ERROR: Error: spawn /Users//.gemini/extensions/cloud-sql-sqlserver/toolbox ENOENT": The Toolbox binary did not download correctly. Ensure you are using Gemini CLI v0.6.0+. +* "✖ MCP ERROR: Error: spawn /Users//.gemini/extensions/bigquery-data-analytics/toolbox ENOENT": The Toolbox binary did not download correctly. Ensure you are using Gemini CLI v0.6.0+. * "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. \ No newline at end of file