Skip to content

Commit de458bd

Browse files
RodriguespnRodriguespn
committed
docs: add root and per-package READMEs
1 parent e3e22c7 commit de458bd

5 files changed

Lines changed: 189 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Supabase Plugin
2+
3+
The official Supabase plugin for AI coding assistants. One plugin, distributed to all supported platforms simultaneously.
4+
5+
## Supported Platforms
6+
7+
| Platform | Package | Install |
8+
|---|---|---|
9+
| [Claude Code](https://claude.ai/code) | [`packages/claude-code`](packages/claude-code) | — |
10+
| [Cursor](https://cursor.com) | [`packages/cursor`](packages/cursor) | — |
11+
| [Gemini CLI](https://github.com/google-gemini/gemini-cli) | [`packages/gemini`](packages/gemini) | `gemini extensions install https://github.com/supabase-community/supabase-plugin` |
12+
| [Codex](https://codex.openai.com) | [`packages/codex`](packages/codex) | — |
13+
14+
## What's Included
15+
16+
Each platform package contains:
17+
18+
- **MCP Server** — Remote connection to the [Supabase MCP server](https://supabase.com/mcp) for project management, SQL execution, migrations, and more
19+
- **Skills** — Agent skills from [supabase/agent-skills](https://github.com/supabase/agent-skills) including `supabase` and `supabase-postgres-best-practices`
20+
21+
## Development
22+
23+
This repo uses a git submodule for shared agent skills.
24+
25+
After cloning, initialize the submodule:
26+
27+
```bash
28+
git submodule update --init --recursive
29+
```
30+
31+
To update the submodule to the latest agent-skills:
32+
33+
```bash
34+
git submodule update --remote submodules/agent-skills
35+
git add submodules/agent-skills
36+
git commit -m "chore: update agent-skills submodule"
37+
```
38+
39+
## Releasing
40+
41+
This repo uses [Release Please](https://github.com/googleapis/release-please) for automated releases. A single release bumps the version in all four platform packages simultaneously.
42+
43+
1. Merge commits with `feat:` or `fix:` prefixes to trigger a release
44+
2. Release Please opens a release PR with version bump and changelog
45+
3. Merge the release PR to publish
46+
4. Four platform archives are uploaded to the GitHub release:
47+
- `supabase-claude-code-plugin.tar.gz`
48+
- `supabase-cursor-plugin.tar.gz`
49+
- `supabase-gemini-extension.tar.gz`
50+
- `supabase-codex-plugin.tar.gz`

‎packages/claude-code/README.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Supabase Plugin for Claude Code
2+
3+
The Supabase plugin for [Claude Code](https://claude.ai/code) gives Claude the tools and skills needed to work effectively with Supabase projects.
4+
5+
## What's Included
6+
7+
- **MCP Server** — Remote connection to the [Supabase MCP server](https://supabase.com/mcp) for project management, SQL execution, migrations, and more
8+
- **Skills** — Agent skills from [supabase/agent-skills](https://github.com/supabase/agent-skills) (e.g. `supabase`, `supabase-postgres-best-practices`)
9+
10+
## Development
11+
12+
This package is part of the [supabase-community/supabase-plugin](https://github.com/supabase-community/supabase-plugin) monorepo.
13+
14+
After cloning the monorepo, initialize the submodule:
15+
16+
```bash
17+
git submodule update --init --recursive
18+
```
19+
20+
To update the submodule:
21+
22+
```bash
23+
git submodule update --remote submodules/agent-skills
24+
git add submodules/agent-skills
25+
git commit -m "chore: update agent-skills submodule"
26+
```
27+
28+
## Releasing
29+
30+
Releases are managed at the monorepo level via [Release Please](https://github.com/googleapis/release-please). See the [root README](../../README.md) for details.

‎packages/codex/README.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Supabase Plugin for Codex
2+
3+
The Supabase plugin for [Codex](https://codex.openai.com) gives Codex the tools and skills needed to work effectively with Supabase projects.
4+
5+
## What's Included
6+
7+
- **MCP Server** — Remote connection to the [Supabase MCP server](https://supabase.com/mcp) for project management, SQL execution, migrations, and more
8+
- **Skills** — Agent skills from [supabase/agent-skills](https://github.com/supabase/agent-skills) (e.g. `supabase`, `supabase-postgres-best-practices`)
9+
10+
## Development
11+
12+
This package is part of the [supabase-community/supabase-plugin](https://github.com/supabase-community/supabase-plugin) monorepo.
13+
14+
After cloning the monorepo, initialize the submodule:
15+
16+
```bash
17+
git submodule update --init --recursive
18+
```
19+
20+
To update the submodule:
21+
22+
```bash
23+
git submodule update --remote submodules/agent-skills
24+
git add submodules/agent-skills
25+
git commit -m "chore: update agent-skills submodule"
26+
```
27+
28+
## Releasing
29+
30+
Releases are managed at the monorepo level via [Release Please](https://github.com/googleapis/release-please). See the [root README](../../README.md) for details.
31+
32+
On release, `supabase-codex-plugin.tar.gz` is uploaded to the GitHub release.

‎packages/cursor/README.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Supabase Plugin for Cursor
2+
3+
The Supabase plugin for [Cursor](https://cursor.com) gives Cursor the tools and skills needed to work effectively with Supabase projects.
4+
5+
## What's Included
6+
7+
- **MCP Server** — Remote connection to the [Supabase MCP server](https://supabase.com/mcp) for project management, SQL execution, migrations, and more
8+
- **Skills** — Agent skills from [supabase/agent-skills](https://github.com/supabase/agent-skills) (e.g. `supabase`, `supabase-postgres-best-practices`)
9+
10+
## Development
11+
12+
This package is part of the [supabase-community/supabase-plugin](https://github.com/supabase-community/supabase-plugin) monorepo.
13+
14+
After cloning the monorepo, initialize the submodule:
15+
16+
```bash
17+
git submodule update --init --recursive
18+
```
19+
20+
To update the submodule:
21+
22+
```bash
23+
git submodule update --remote submodules/agent-skills
24+
git add submodules/agent-skills
25+
git commit -m "chore: update agent-skills submodule"
26+
```
27+
28+
## Releasing
29+
30+
Releases are managed at the monorepo level via [Release Please](https://github.com/googleapis/release-please). See the [root README](../../README.md) for details.
31+
32+
On release, `supabase-cursor-plugin.tar.gz` is uploaded to the GitHub release.

‎packages/gemini/README.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Supabase Extension for Gemini CLI
2+
3+
The Supabase extension for [Gemini CLI](https://github.com/google-gemini/gemini-cli) gives Gemini the tools, skills, and context needed to work effectively with Supabase projects.
4+
5+
## Installation
6+
7+
```bash
8+
gemini extensions install https://github.com/supabase-community/supabase-plugin
9+
```
10+
11+
## What's Included
12+
13+
- **MCP Server** — Remote connection to the [Supabase MCP server](https://supabase.com/mcp) for project management, SQL execution, migrations, and more
14+
- **Skills** — Agent skills from [supabase/agent-skills](https://github.com/supabase/agent-skills) (e.g. `supabase`, `supabase-postgres-best-practices`)
15+
- **Context** — `SUPABASE.md` with CLI usage patterns and best practices
16+
17+
## Development
18+
19+
This package is part of the [supabase-community/supabase-plugin](https://github.com/supabase-community/supabase-plugin) monorepo.
20+
21+
After cloning the monorepo, initialize the submodule:
22+
23+
```bash
24+
git submodule update --init --recursive
25+
```
26+
27+
To test locally:
28+
29+
```bash
30+
gemini extensions install ./packages/gemini
31+
```
32+
33+
To update the submodule:
34+
35+
```bash
36+
git submodule update --remote submodules/agent-skills
37+
git add submodules/agent-skills
38+
git commit -m "chore: update agent-skills submodule"
39+
```
40+
41+
## Releasing
42+
43+
Releases are managed at the monorepo level via [Release Please](https://github.com/googleapis/release-please). See the [root README](../../README.md) for details.
44+
45+
On release, `supabase-gemini-extension.tar.gz` is uploaded to the GitHub release.

0 commit comments

Comments
 (0)