mirror of
https://github.com/supabase/setup-cli.git
synced 2026-06-28 01:46:58 +00:00
56 lines
1.2 KiB
Markdown
56 lines
1.2 KiB
Markdown
# `supabase/setup-cli`
|
|
|
|
The Supabase CLI Action provides an easy way to install the
|
|
[Supabase CLI](https://github.com/supabase/cli) on GitHub Actions runners.
|
|
|
|
The action supports `ubuntu-latest`, `windows-latest`, and `macos-latest`, and
|
|
adds the requested `supabase` version to `PATH` for the rest of the job.
|
|
|
|
If `version` is omitted, the action checks the repository root for `bun.lock`,
|
|
`pnpm-lock.yaml`, or `package-lock.json` and otherwise falls back to npm
|
|
`latest`.
|
|
|
|
The action provisions Node.js and npm internally; runners only need network
|
|
access to the npm registry.
|
|
|
|
## Quick Start
|
|
|
|
This example runs Supabase migrations on every pull request:
|
|
|
|
```yaml
|
|
name: test-migrations
|
|
|
|
on:
|
|
pull_request:
|
|
|
|
jobs:
|
|
test-migrations:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v6
|
|
- uses: supabase/setup-cli@v3
|
|
- run: supabase init
|
|
- run: supabase db start
|
|
```
|
|
|
|
To pin a fixed npm-published CLI version:
|
|
|
|
```yaml
|
|
- uses: supabase/setup-cli@v3
|
|
with:
|
|
version: 2.84.2
|
|
```
|
|
|
|
To test the current beta release:
|
|
|
|
```yaml
|
|
- uses: supabase/setup-cli@v3
|
|
with:
|
|
version: beta
|
|
```
|
|
|
|
## Resources
|
|
|
|
- **Source Code**: <https://github.com/supabase/setup-cli>
|
|
- **CLI Documentation**: <https://supabase.com/docs/guides/cli>
|