From 15656b543cde54ce4e17394459006352680f30eb Mon Sep 17 00:00:00 2001 From: Averi Kitsch Date: Tue, 14 Oct 2025 16:55:34 -0700 Subject: [PATCH 1/2] docs: update readme with form --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 198e60b..d508978 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,12 @@ Developers can effortlessly connect, interact, and generate data insights with [BigQuery](https://cloud.google.com/bigquery/docs) datasets and data using natural language commands. Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini-cli/blob/main/docs/extensions/index.md). +> [!IMPORTANT] +> **We Want Your Feedback!** +> Please share your thoughts with us by filling out our feedback [form][form]. +> Your input is invaluable and helps us improve the project for everyone. + +[form]: https://docs.google.com/forms/d/e/1FAIpQLSfEGmLR46iipyNTgwTmIDJqzkAwDPXxbocpXpUbHXydiN1RTw/viewform?usp=pp_url&entry.157487=bigquery-conversational-analytics ## **Why Use the BigQuery Conversational Analytics Extension?** @@ -13,12 +19,17 @@ Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini * **Seamless Workflow:** Stay in your CLI. No need to constantly switch contexts to the GCP console for generating analytics insights. . * **Leverage prebuilt agent :** Access to advanced insights offered by a built-in agent behind [Conversational Analytics API](https://cloud.google.com/gemini/docs/conversational-analytics-api/overview) -## **Prerequisites** + + + +## Prerequisites Before you begin, ensure you have the following: * [Gemini CLI](https://github.com/google-gemini/gemini-cli) installed with version **+v0.6.0**. +* Setup Gemini CLI [Authentication](https://github.com/google-gemini/gemini-cli/tree/main?tab=readme-ov-file#-authentication-options). * A Google Cloud project with the **Data Analytics API with Gemini**, **Gemini for Google Cloud API** and **BigQuery API** enabled. +* Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment. * IAM Roles: * BigQuery User (`roles/bigquery.user`) (for executing queries and view metadata) * Gemini for Google Cloud (`roles/cloudaicompanion.user`) (to use the conversational analytics API) @@ -35,11 +46,11 @@ gemini extensions install https://github.com/gemini-cli-extensions/bigquery-conv ### Configuration -Set the following environment variables before starting the Gemini CLI: +Set the following environment variables before starting the Gemini CLI. These variables can be loaded from a `.env` file. -* `BIGQUERY_PROJECT`: The GCP project ID. -* `BIGQUERY_LOCATION`: (Optional) The dataset location. -* `BIGQUERY_USE_CLIENT_OAUTH`: (Optional) Set to `true` to use client-side OAuth for authorization. +* `BIGQUERY_PROJECT`: The GCP project ID. +* `BIGQUERY_LOCATION`: (Optional) The dataset location. +* `BIGQUERY_USE_CLIENT_OAUTH`: (Optional) Set to `true` to use client-side OAuth for authorization. Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment. From 2f7869f6581ec52384cbc39de21af7d8e4d40d3c Mon Sep 17 00:00:00 2001 From: Averi Kitsch Date: Thu, 16 Oct 2025 14:15:23 -0700 Subject: [PATCH 2/2] docs: make env vars copy/paste-able --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d508978..0adce75 100644 --- a/README.md +++ b/README.md @@ -48,9 +48,11 @@ gemini extensions install https://github.com/gemini-cli-extensions/bigquery-conv Set the following environment variables before starting the Gemini CLI. These variables can be loaded from a `.env` file. -* `BIGQUERY_PROJECT`: The GCP project ID. -* `BIGQUERY_LOCATION`: (Optional) The dataset location. -* `BIGQUERY_USE_CLIENT_OAUTH`: (Optional) Set to `true` to use client-side OAuth for authorization. +```bash +export BIGQUERY_PROJECT="" +export BIGQUERY_LOCATION="" # Optional +export BIGQUERY_USE_CLIENT_OAUTH="true" # Optional +``` Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.