Skip to content

Commit b4e2e1e

Browse files
averikitschYuan325
andauthored
docs: update readme getting started instructions (#23)
* 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 8eae30d commit b4e2e1e

1 file changed

Lines changed: 15 additions & 3 deletions

File tree

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,22 +23,32 @@ Before you begin, ensure you have the following:
2323
* Dataplex Data Reader (`roles/dataplex.dataReader`): For reading data from the underlying assets (e.g., to run analytics queries).
2424
* Service Usage Consumer (`roles/serviceusage.serviceUsageConsumer`)
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/dataplex
3234
```
3335

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

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

3840
* `DATAPLEX_PROJECT`: The GCP project ID.
3941

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

44+
### Start Gemini CLI
45+
46+
To start the Gemini CLI, use the following command:
47+
48+
```bash
49+
gemini
50+
```
51+
4252
## Usage Examples
4353

4454
Interact with Dataplex using natural language right from your IDE:
@@ -63,4 +73,6 @@ Find additional extensions to support your entire software development lifecycle
6373

6474
## Troubleshooting
6575

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