Installation

Tip

We recommend using Bun as your package manager.

While other package managers will probably work too, we only use Bun for testing.

Environment

The following environment variables are required when working with linked projects:

Name	Description
`SUPABASE_ACCESS_TOKEN`	An access token to access the management api.
`SUPABASE_PASSWORD`	The database password.
`SUPABASE_ANON_KEY`	The anonymous key.
`SUPABASE_SERVICE_KEY`	The service key.

Create a .env file in your project root with these variables set.

bun add -d @actcoding/supa-cli

That's it!

Run the following command to verify everything is working fine:

bunx supa --version

You might want to create a shortcut script in your project root with the following content:

supa

#!/bin/sh

bun run cli/index.ts $*

We like to call it just supa, but you may use any name you want.

Don't forget to make it executable:

chmod +x ./supa