Skip to content

Commit 49fb4f4

Browse files
authored
docs: moved command descriptions from docs repo (#3533)
docs: add long descriptions to some commands for documentation Descriptions were added for some of these commands over in the [docs repo](https://github.com/supabase/supabase/pull/35490/files), but the spec auto-generation will overwrite them there. Adding to the command description here instead.
1 parent 668c9bc commit 49fb4f4

File tree

6 files changed

+48
-0
lines changed

6 files changed

+48
-0
lines changed

docs/supabase/config/push.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# supabase-config-push
2+
3+
Updates the configurations of a linked Supabase project with the local `supabase/config.toml` file.
4+
5+
This command allows you to manage project configuration as code by defining settings locally and then pushing them to your remote project.

docs/supabase/functions.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## supabase-functions
2+
3+
Manage Supabase Edge Functions.
4+
5+
Supabase Edge Functions are server-less functions that run close to your users.
6+
7+
Edge Functions allow you to execute custom server-side code without deploying or scaling a traditional server. They're ideal for handling webhooks, custom API endpoints, data validation, and serving personalized content.
8+
9+
Edge Functions are written in TypeScript and run on Deno compatible edge runtime, which is a secure runtime with no package management needed, fast cold starts, and built-in security.

docs/supabase/functions/new.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## supabase-functions-new
2+
3+
Creates a new Edge Function with boilerplate code in the `supabase/functions` directory.
4+
5+
This command generates a starter TypeScript file with the necessary Deno imports and a basic function structure. The function is created as a new directory with the name you specify, containing an `index.ts` file with the function code.
6+
7+
After creating the function, you can edit it locally and then use `supabase functions serve` to test it before deploying with `supabase functions deploy`.

docs/supabase/gen.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## supabase-gen
2+
3+
Automatically generates type definitions based on your Postgres database schema.
4+
5+
This command connects to your database (local or remote) and generates typed definitions that match your database tables, views, and stored procedures. By default, it generates TypeScript definitions, but also supports Go and Swift.
6+
7+
Generated types give you type safety and autocompletion when working with your database in code, helping prevent runtime errors and improving developer experience.
8+
9+
The types respect relationships, constraints, and custom types defined in your database schema.

docs/supabase/projects.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## supabase-projects
2+
3+
Provides tools for creating and managing your Supabase projects.
4+
5+
This command group allows you to list all projects in your organizations, create new projects, delete existing projects, and retrieve API keys. These operations help you manage your Supabase infrastructure programmatically without using the dashboard.
6+
7+
Project management via CLI is especially useful for automation scripts and when you need to provision environments in a repeatable way.

docs/supabase/secrets.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## supabase-secrets
2+
3+
Provides tools for managing environment variables and secrets for your Supabase project.
4+
5+
This command group allows you to set, unset, and list secrets that are securely stored and made available to Edge Functions as environment variables.
6+
7+
Secrets management through the CLI is useful for:
8+
- Setting environment-specific configuration
9+
- Managing sensitive credentials securely
10+
11+
Secrets can be set individually or loaded from .env files for convenience.

0 commit comments

Comments
 (0)