Skip to content

Commit 93f9e77

Browse files
twishabansaltwishabansal
committed
update
1 parent 6bec132 commit 93f9e77

1 file changed

Lines changed: 125 additions & 51 deletions

File tree

‎README.md‎

Lines changed: 125 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Gemini CLI Extension - BigQuery Data Analytics
1+
# BigQuery Data Analytics Skills
22

33
> [!NOTE]
4-
> This extension is currently in beta (pre-v1.0), and may see breaking changes until the first stable release (v1.0).
4+
> Currently in beta (pre-v1.0), and may see breaking changes until the first stable release (v1.0).
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

@@ -50,18 +50,9 @@ Before you begin, ensure you have the following:
5050

5151
## Getting Started
5252

53-
<details>
54-
<summary><b>Gemini CLI</b></summary>
55-
56-
To install the extension for Gemini CLI, use the command:
57-
58-
```bash
59-
gemini extensions install https://github.com/gemini-cli-extensions/bigquery-data-analytics
60-
```
61-
62-
#### Configuration
53+
### Configuration
6354

64-
You will be prompted to configure the following settings during installation. These settings are saved in an `.env` file within the extension's directory.
55+
Please keep these env vars handy during the installation process:
6556

6657
* `BIGQUERY_PROJECT`: The GCP project ID.
6758
* `BIGQUERY_LOCATION`: (Optional) The dataset location.
@@ -70,77 +61,160 @@ You will be prompted to configure the following settings during installation. Th
7061
* `BIGQUERY_MAX_QUERY_RESULT_ROWS`: (Optional) Maximum number of query result rows (default: 50).
7162
* `BIGQUERY_IMPERSONATE_SERVICE_ACCOUNT`: (Optional) Service account to impersonate.
7263

73-
To view or update your configuration:
64+
> [!NOTE]
65+
>
66+
> - Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
67+
68+
### Installation & Usage
69+
70+
To start interacting with your database, install the skills for your preferred AI agent, then launch the agent and use natural language to ask questions or perform tasks.
7471

75-
**List Settings:**
76-
* Terminal: `gemini extensions list`
77-
* Gemini CLI: `/extensions list`
72+
For the latest version, check the [releases page][releases].
7873

79-
**Update Settings:**
80-
* Terminal: `gemini extensions config bigquery-data-analytics [setting name] [--scope <scope>]`
81-
* `setting name`: (Optional) The single setting to configure.
82-
* `scope`: (Optional) The scope of the setting in (`user` or `workspace`). Defaults to `user`.
74+
[releases]: https://github.com/gemini-cli-extensions/bigquery-data-analytics/releases
8375

84-
Alternatively, you can manually set these environment variables before starting the Gemini CLI:
76+
<!-- {x-release-please-start-version} -->
77+
78+
<details open>
79+
<summary id="gemini-cli">Gemini CLI</summary>
80+
81+
**1. Install the extension:**
8582

8683
```bash
87-
export BIGQUERY_PROJECT="<your-gcp-project-id>"
88-
export BIGQUERY_LOCATION="<your-dataset-location>" # Optional
89-
export BIGQUERY_USE_CLIENT_OAUTH="false" # Optional
90-
export BIGQUERY_SCOPES="" # Optional
91-
export BIGQUERY_MAX_QUERY_RESULT_ROWS="50" # Optional
92-
export BIGQUERY_IMPERSONATE_SERVICE_ACCOUNT="" # Optional
84+
gemini extensions install https://github.com/gemini-cli-extensions/bigquery-data-analytics
9385
```
9486

95-
#### Start Gemini CLI
87+
During the installation, enter your environment vars as described in the [configuration section](#configuration).
9688

97-
To start the Gemini CLI, use the following command:
89+
**2. (Optional) Manage Configuration:**
90+
To view or update your configuration in Gemini CLI:
91+
92+
- Terminal: `gemini extensions config bigquery-data-analytics [setting name] [--scope <scope>]`
93+
- Gemini CLI: `/extensions list`
94+
95+
**3. Start the agent:**
9896

9997
```bash
10098
gemini
10199
```
102100

101+
_(Tip: Run `/extensions list` to verify your configuration and active extensions.)_
102+
103+
> [!WARNING]
104+
> **Changing Instance & Database Connections**
105+
> Currently, the database connection must be configured before starting the agent and can not be changed during a session.
106+
> To save and resume conversation history in Gemini CLI use command: `/chat save <tag>` and `/chat resume <tag>`.
107+
103108
</details>
104109

105110
<details>
106-
<summary><b>Claude Code</b></summary>
111+
<summary id="claude-code">Claude Code</summary>
112+
113+
**1. Set env vars:**
114+
In your terminal, set your environment vars as described in the [configuration section](#configuration).
115+
116+
**2. Start the agent:**
117+
118+
```bash
119+
claude
120+
```
121+
122+
**3. Add the marketplace:**
123+
124+
```bash
125+
/plugin marketplace add https://github.com/gemini-cli-extensions/bigquery-data-analytics.git#0.1.7
126+
```
127+
128+
**4. Install the plugin:**
107129

108-
To use these skills with [Claude Code](https://docs.anthropic.com/en/docs/agents-and-tools/claude-code):
130+
```bash
131+
/plugin install bigquery-data-analytics@bigquery-data-analytics-marketplace
132+
```
109133

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.
134+
_(Tip: Run `/plugin list` inside Claude Code to verify the plugin is active, or `/reload-plugins` if you just installed it.)_
116135

117136
</details>
118137

119138
<details>
120-
<summary><b>Codex</b></summary>
139+
<summary id="codex">Codex</summary>
121140

122-
To use these skills with [Codex](https://github.com/google-gemini/codex):
141+
**1. Clone the Repo:**
142+
143+
```bash
144+
git clone --branch 0.1.7 git@github.com:gemini-cli-extensions/bigquery-data-analytics.git
145+
```
146+
147+
**2. Install the plugin:**
148+
149+
```bash
150+
mkdir -p ~/.codex/plugins
151+
cp -R /absolute/path/to/bigquery-data-analytics ~/.codex/plugins/bigquery-data-analytics
152+
```
153+
154+
**3. Set env vars:**
155+
Enter your environment vars as described in the [configuration section](#configuration).
156+
157+
**4. Create or update marketplace.json:**
158+
`~/.agents/plugins/marketplace.json`
159+
160+
```json
161+
{
162+
"name": "my-data-cloud-google-marketplace",
163+
"interface": {
164+
"displayName": "Google Data Cloud Skills"
165+
},
166+
"plugins": [
167+
{
168+
"name": "bigquery-data-analytics",
169+
"source": {
170+
"source": "local",
171+
"path": "./plugins/bigquery-data-analytics"
172+
},
173+
"policy": {
174+
"installation": "AVAILABLE",
175+
"authentication": "ON_INSTALL"
176+
},
177+
"category": "Database"
178+
}
179+
]
180+
}
181+
```
123182

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.
183+
_(Tip: Run `codex plugin list` or use the `/plugins` interactive menu to verify your installed plugins.)_
128184

129185
</details>
130186

131187
<details>
132-
<summary><b>Antigravity</b></summary>
188+
<summary id="antigravity">Antigravity</summary>
133189

134-
To use these skills with [Antigravity](https://github.com/google-gemini/antigravity):
190+
**1. Clone the Repo:**
135191

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.
192+
```bash
193+
git clone --branch 0.1.7 https://github.com/gemini-cli-extensions/bigquery-data-analytics.git
194+
```
195+
196+
**2. Install the skills:**
197+
198+
Choose a location for the skills:
199+
- **Global (all workspaces):** `~/.gemini/antigravity/skills/`
200+
- **Workspace-specific:** `<workspace-root>/.agents/skills/`
201+
202+
Copy the skill folders from the cloned repository's `skills/` directory to your chosen location:
203+
204+
```bash
205+
cp -R bigquery-data-analytics/skills/* ~/.gemini/antigravity/skills/
206+
```
207+
208+
**3. Set env vars:**
209+
Set your environment vars as described in the [configuration section](#configuration).
210+
211+
_(Tip: Antigravity automatically discovers skills in these directories at the start of a session.)_
141212

142213
</details>
143214

215+
<!-- {x-release-please-end} -->
216+
217+
144218
> [!NOTE]
145219
> * Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
146220
> * See [Troubleshooting](#troubleshooting) for debugging your configuration.

0 commit comments

Comments
 (0)