Skip to content

Commit 8d0f36b

Browse files
committed
update readme
1 parent 073d4c0 commit 8d0f36b

1 file changed

Lines changed: 58 additions & 25 deletions

File tree

README.md

Lines changed: 58 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -35,23 +35,6 @@ Before you begin, ensure you have the following:
3535
3636
## Getting Started
3737

38-
### Configuration
39-
40-
You may be prompted to configure the following settings during installation. These settings can also be set as environment variables.
41-
42-
- `CLOUD_SQL_POSTGRES_PROJECT`: The GCP project ID.
43-
- `CLOUD_SQL_POSTGRES_REGION`: The region of your Cloud SQL instance.
44-
- `CLOUD_SQL_POSTGRES_INSTANCE`: The ID of your Cloud SQL instance.
45-
- `CLOUD_SQL_POSTGRES_DATABASE`: The name of the database to connect to.
46-
- `CLOUD_SQL_POSTGRES_USER`: (Optional) The database username. Defaults to the active IAM user.
47-
- `CLOUD_SQL_POSTGRES_PASSWORD`: (Optional) The password for the database user.
48-
- `CLOUD_SQL_POSTGRES_IP_TYPE`: (Optional) Type of the IP address: `PUBLIC`, `PRIVATE`, or `PSC`. Defaults to `PUBLIC`.
49-
50-
> [!NOTE]
51-
>
52-
> - Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
53-
> - If your Cloud SQL for PostgreSQL instance uses private IPs, you must run your agent in the same Virtual Private Cloud (VPC) network.
54-
5538
### Installation & Usage
5639

5740
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.
@@ -76,30 +59,80 @@ _(Tip: Run `/extensions list` to verify your configuration and active extensions
7659

7760
#### Claude Code
7861

79-
**1. Install the plugin:**
62+
**1. Start the agent:**
8063
```bash
81-
claude plugin add https://github.com/gemini-cli-extensions/cloud-sql-postgresql
64+
claude
8265
```
8366

84-
**2. Start the agent:**
67+
**2. Add the marketplace:**
8568
```bash
86-
claude
69+
/plugin marketplace add gemini-cli-extensions/cloud-sql-postgresql
70+
```
71+
72+
**3. Install the plugin:**
73+
```bash
74+
/plugin install cloud-sql-postgresql@google-data-cloud-skills
8775
```
8876
_(Tip: Run `/plugin list` inside Claude Code to verify the plugin is active, or `/reload-plugins` if you just installed it.)_
8977

9078
#### Codex
9179

92-
**1. Install the plugin:**
80+
**1. Clone the Repo:**
9381
```bash
94-
codex plugin add https://github.com/gemini-cli-extensions/cloud-sql-postgresql
82+
git clone git@github.com:gemini-cli-extensions/cloud-sql-postgresql.git
9583
```
9684

97-
**2. Start the agent:**
85+
**2. Install the plugin:**
9886
```bash
99-
codex
87+
mkdir -p ~/.codex/plugins
88+
cp -R /absolute/path/to/cloud-sql-postgresql ~/.codex/plugins/cloud-sql-postgresql
10089
```
90+
91+
**3. Create or update marketplace.json:**
92+
`~/.agents/plugins/marketplace.json`
93+
```json
94+
{
95+
"name": "google-data-cloud-skills",
96+
"interface": {
97+
"displayName": "Google Data Cloud Skills"
98+
},
99+
"plugins": [
100+
{
101+
"name": "cloud-sql-postgresql",
102+
"source": {
103+
"source": "local",
104+
"path": "./plugins/cloud-sql-postgresql"
105+
},
106+
"policy": {
107+
"installation": "AVAILABLE",
108+
"authentication": "ON_INSTALL"
109+
},
110+
"category": "Database"
111+
}
112+
]
113+
}
114+
115+
```
116+
101117
_(Tip: Run `codex plugin list` or use the `/plugins` interactive menu to verify your installed plugins.)_
102118

119+
### Configuration
120+
121+
You may be prompted to configure the following settings during installation. These settings can also be set as environment variables.
122+
123+
- `CLOUD_SQL_POSTGRES_PROJECT`: The GCP project ID.
124+
- `CLOUD_SQL_POSTGRES_REGION`: The region of your Cloud SQL instance.
125+
- `CLOUD_SQL_POSTGRES_INSTANCE`: The ID of your Cloud SQL instance.
126+
- `CLOUD_SQL_POSTGRES_DATABASE`: The name of the database to connect to.
127+
- `CLOUD_SQL_POSTGRES_USER`: (Optional) The database username. Defaults to the active IAM user.
128+
- `CLOUD_SQL_POSTGRES_PASSWORD`: (Optional) The password for the database user.
129+
- `CLOUD_SQL_POSTGRES_IP_TYPE`: (Optional) Type of the IP address: `PUBLIC`, `PRIVATE`, or `PSC`. Defaults to `PUBLIC`.
130+
131+
> [!NOTE]
132+
>
133+
> - Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
134+
> - If your Cloud SQL for PostgreSQL instance uses private IPs, you must run your agent in the same Virtual Private Cloud (VPC) network.
135+
103136
> [!WARNING]
104137
> **Changing Instance & Database Connections**
105138
> Currently, the database connection must be configured before starting the agent and can not be changed during a session.

0 commit comments

Comments
 (0)