Skip to content

Commit 1265ca2

Browse files
committed
small fix
1 parent 6557b3a commit 1265ca2

2 files changed

Lines changed: 74 additions & 15 deletions

File tree

DEVELOPER.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Before you begin, ensure you have the following:
1010
1. **Gemini CLI:** Install the Gemini CLI version v0.6.0 or above. Installation
1111
instructions can be found on the official Gemini CLI documentation. You can
1212
verify your version by running `gemini --version`.
13-
2. **BigQuery Access** For testing data plane tools, you will need access to an active BigQuery dataset.
13+
2. **BigQuery Access** For testing data plane skills, you will need access to an active BigQuery dataset.
1414

1515
## Developing the Extension
1616

README.md

Lines changed: 73 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,31 @@
55
66
Developers can effortlessly connect, interact, and generate data insights with [BigQuery](https://cloud.google.com/bigquery/docs) datasets and data using natural language commands.
77

8-
Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini-cli/blob/main/docs/extensions/index.md).
8+
[Learn more about Gemini CLI Extensions](https://github.com/google-gemini/gemini-cli/blob/main/docs/extensions/index.md).
9+
910
> [!IMPORTANT]
1011
> **We Want Your Feedback!**
1112
> Please share your thoughts with us by filling out our feedback [form][form].
1213
> Your input is invaluable and helps us improve the project for everyone.
1314
1415
[form]: https://docs.google.com/forms/d/e/1FAIpQLSfEGmLR46iipyNTgwTmIDJqzkAwDPXxbocpXpUbHXydiN1RTw/viewform?usp=pp_url&entry.157487=bigquery-data-analytics
1516

17+
---
18+
19+
- [Why Use the BigQuery Data Analytics Extension?](#why-use-the-bigquery-data-analytics-extension)
20+
- [Prerequisites](#prerequisites)
21+
- [Getting Started](#getting-started)
22+
- [Gemini CLI](#gemini-cli)
23+
- [Claude Code](#claude-code)
24+
- [Codex](#codex)
25+
- [Antigravity](#antigravity)
26+
- [Usage Examples](#usage-examples)
27+
- [Supported Skills](#supported-skills)
28+
- [Additional Extensions](#additional-extensions)
29+
- [Troubleshooting](#troubleshooting)
30+
31+
---
32+
1633
## Why Use the BigQuery Data Analytics Extension?
1734

1835
* **Natural Language to data analytics :** Find required BigQuery tables and ask analytical questions in natural language.
@@ -33,15 +50,16 @@ Before you begin, ensure you have the following:
3350

3451
## Getting Started
3552

36-
### Installation
53+
<details>
54+
<summary><b>Gemini CLI</b></summary>
3755

38-
To install the extension, use the command:
56+
To install the extension for Gemini CLI, use the command:
3957

4058
```bash
4159
gemini extensions install https://github.com/gemini-cli-extensions/bigquery-data-analytics
4260
```
4361

44-
### Configuration
62+
#### Configuration
4563

4664
You will be prompted to configure the following settings during installation. These settings are saved in an `.env` file within the extension's directory.
4765

@@ -62,7 +80,6 @@ To view or update your configuration:
6280
* Terminal: `gemini extensions config bigquery-data-analytics [setting name] [--scope <scope>]`
6381
* `setting name`: (Optional) The single setting to configure.
6482
* `scope`: (Optional) The scope of the setting in (`user` or `workspace`). Defaults to `user`.
65-
* Currently, you must restart the Gemini CLI for changes to take effect. We recommend using `gemini --resume` to resume your session.
6683

6784
Alternatively, you can manually set these environment variables before starting the Gemini CLI:
6885

@@ -75,18 +92,60 @@ export BIGQUERY_MAX_QUERY_RESULT_ROWS="50" # Optional
7592
export BIGQUERY_IMPERSONATE_SERVICE_ACCOUNT="" # Optional
7693
```
7794

78-
> [!NOTE]
79-
> * Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
80-
> * See [Troubleshooting](#troubleshooting) for debugging your configuration.
81-
82-
### Start Gemini CLI
95+
#### Start Gemini CLI
8396

8497
To start the Gemini CLI, use the following command:
8598

8699
```bash
87100
gemini
88101
```
89102

103+
</details>
104+
105+
<details>
106+
<summary><b>Claude Code</b></summary>
107+
108+
To use these skills with [Claude Code](https://docs.anthropic.com/en/docs/agents-and-tools/claude-code):
109+
110+
1. Navigate to your project directory.
111+
2. Add the plugin:
112+
```bash
113+
claude mcp add bigquery-data-analytics https://github.com/gemini-cli-extensions/bigquery-data-analytics
114+
```
115+
3. Claude will prompt you for the required configuration values.
116+
117+
</details>
118+
119+
<details>
120+
<summary><b>Codex</b></summary>
121+
122+
To use these skills with [Codex](https://github.com/google-gemini/codex):
123+
124+
1. Open the Codex interface.
125+
2. Navigate to the **Extensions** or **Plugins** section.
126+
3. Search for `bigquery-data-analytics` or provide the repository URL: `https://github.com/gemini-cli-extensions/bigquery-data-analytics`.
127+
4. Follow the on-screen instructions to install and configure.
128+
129+
</details>
130+
131+
<details>
132+
<summary><b>Antigravity</b></summary>
133+
134+
To use these skills with [Antigravity](https://github.com/google-gemini/antigravity):
135+
136+
1. Install the skills using the Antigravity CLI:
137+
```bash
138+
antigravity skills install https://github.com/gemini-cli-extensions/bigquery-data-analytics
139+
```
140+
2. Configure the environment variables as prompted or in your `.env` file.
141+
142+
</details>
143+
144+
> [!NOTE]
145+
> * Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
146+
> * See [Troubleshooting](#troubleshooting) for debugging your configuration.
147+
148+
90149
## Usage Examples
91150

92151
Interact with BigQuery using natural language right from your IDE:
@@ -120,7 +179,7 @@ Use `gemini --debug` to enable debugging.
120179

121180
Common issues:
122181

123-
* "failed to find default credentials: google: could not find default credentials.": Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment. See [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/external/set-up-adc) for more information.
124-
* "✖ 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.
125-
* "✖ 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+.
126-
* "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://mcp-toolbox.dev/documentation/introduction/#install-toolbox) for more information.
182+
* **"failed to find default credentials: google: could not find default credentials."**: Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/external/set-up-adc) are available in your environment. See [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/external/set-up-adc) for more information.
183+
* **"✖ 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.
184+
* **"✖ 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+.
185+
* **"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://mcp-toolbox.dev/documentation/introduction/#install-toolbox) for more information.

0 commit comments

Comments
 (0)