dima/supabase
1
0 Fork 0
mirror of https://github.com/supabase/supabase.git synced 2026-10-06 09:55:06 +03:00
Code Issues Packages Projects Releases Wiki Activity
38,161 Commits 1,781 Branches 62 Tags
cli/ref-doc
Commit Graph
100 Commits
Author SHA1 Message Date
github-actions[bot] ac392327bd chore: update cli reference doc 2026-09-30 21:41:53 +00:00
github-actions[bot] 9b8bd0747f chore: update cli reference doc 2026-09-25 13:30:31 +00:00
github-actions[bot] f886da0ef3 chore: update cli reference doc 2026-09-07 16:53:08 +00:00
github-actions[bot] 4567d23b62 chore: update cli reference doc 2026-08-26 20:20:25 +00:00
supabase-supabase-autofixer[bot]andsupabase-releaser[bot] d71717585e docs: update js sdk docs (2.105.4) (#45718) 
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `2.105.4`
- **Source:** `supabase-js-stable-release`
- **Changes:** Regenerated tsdoc files from latest spec files

🤖 Auto-generated from @supabase/supabase-js stable release.

Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
 2026-05-08 18:01:36 +03:00
supabase-cli-releaser[bot] 6fe847c904 chore: update cli reference doc (#45622) 
Co-authored-by: supabase-cli-releaser[bot] <246109035+supabase-cli-releaser[bot]@users.noreply.github.com>
 2026-05-06 16:47:28 +02:00
supabase-supabase-autofixer[bot]andsupabase-releaser[bot] b01941275b docs: update js sdk docs (2.105.2) (#45559) 
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `2.105.2`
- **Source:** `supabase-js-stable-release`
- **Changes:** Regenerated tsdoc files from latest spec files

🤖 Auto-generated from @supabase/supabase-js stable release.

Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
 2026-05-05 11:07:24 +02:00
supabase-cli-releaser[bot] 82e498958b chore: update cli reference doc (#45531) 
Co-authored-by: supabase-cli-releaser[bot] <246109035+supabase-cli-releaser[bot]@users.noreply.github.com>
 2026-05-04 18:20:08 +02:00
supabase-supabase-autofixer[bot]andsupabase-releaser[bot] 78c5a5399b docs: update js sdk docs (2.105.0) (#45287) 
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `2.105.0`
- **Source:** `supabase-js-stable-release`
- **Changes:** Regenerated tsdoc files from latest spec files

🤖 Auto-generated from @supabase/supabase-js stable release.

Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
 2026-04-27 18:56:57 +02:00
supabase-cli-releaser[bot] ef5ec5f06e chore: update cli reference doc (#45268) 
Co-authored-by: supabase-cli-releaser[bot] <246109035+supabase-cli-releaser[bot]@users.noreply.github.com>
 2026-04-27 11:18:26 +02:00
Laurence Isla 08e9cdde5e docs: data api docs functions (#44412) 
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## What kind of change does this PR introduce?

Replaces "stored procedures" with "functions" for everything related to
the Data API.

## Additional context

It's not accurate to call database functions "stored procedures". It may
have been that way before Postgres 11, but now it causes confusion
because PostgREST allows functions and not stored procedures.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Standardized terminology across docs, SDK guides, CLI/config specs,
examples, UI, and config comments to use "database functions" instead of
"stored procedures".
* Updated API docs, CLI/config descriptions, Studio UI labels, help
text, empty-state and navigation copy, RPC documentation, and example
text for consistency.
* Adjusted explanatory text and error/help messages to reflect the
revised terminology.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
 2026-04-21 11:54:27 +10:00
supabase-supabase-autofixer[bot]andmandarini ea15a7b8b9 docs: update js sdk docs (v2.103.3) (#44944) 
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `v2.103.3`
- **Source:** `manual`
- **Changes:** Regenerated tsdoc files from latest spec files

🤖 Auto-generated from @supabase/supabase-js stable release.

Co-authored-by: mandarini <6603745+mandarini@users.noreply.github.com>
 2026-04-16 17:24:51 +02:00
supabase-cli-releaser[bot] 676d4b927d chore: update cli reference doc (#44815) 
Co-authored-by: supabase-cli-releaser[bot] <246109035+supabase-cli-releaser[bot]@users.noreply.github.com>
 2026-04-16 16:04:03 +02:00
Pamela Chia 2536593594 docs: CLI telemetry disclosure (#44662) 
## Summary

The CLI now collects usage telemetry (supabase/cli#5019) with opt-out
via `supabase telemetry disable` or `SUPABASE_TELEMETRY_DISABLED=1`. The
self-hosting docs previously stated "no telemetry" without
distinguishing Docker from the CLI. This PR discloses CLI telemetry
across docs and regenerates the CLI reference spec to include the new
telemetry commands.

## Changes
- Update self-hosting telemetry section: Docker has no telemetry, CLI is
separate with opt-out instructions and link to full telemetry docs
- Regenerate `cli_v1_commands.yaml` from CLI v2.88.0, adding
consolidated `supabase telemetry` reference page
- Add Telemetry category to `common-cli-sections.json` for CLI reference
nav
- Add telemetry section to CLI getting-started guide with opt-out
commands and env vars

## Testing

Tested on Vercel preview:
- [x] `/docs/guides/self-hosting#telemetry` renders with CLI telemetry
note and link to full docs
- [x] `/docs/reference/cli/supabase-telemetry` renders single
consolidated reference page
- [x] `/docs/guides/local-development/cli/getting-started#telemetry`
shows opt-out section

## Linear
- fixes GROWTH-754
 2026-04-08 22:06:56 +09:00
supabase-supabase-autofixer[bot]andsupabase-releaser[bot] d58cc5b157 docs: update js sdk docs (2.100.1) (#44236) 
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `2.100.1`
- **Source:** `supabase-js-stable-release`
- **Changes:** Regenerated tsdoc files from latest spec files

🤖 Auto-generated from @supabase/supabase-js stable release.

Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
 2026-03-27 11:39:52 +01:00
supabase-cli-releaser[bot] 06bd4b29e1 chore: update cli reference doc (#44202) 
Co-authored-by: supabase-cli-releaser[bot] <246109035+supabase-cli-releaser[bot]@users.noreply.github.com>
 2026-03-26 10:29:01 +01:00
Katerina Skroumpelou 49df02ce91 docs: move postgrest-js and realtime-js docs to tsdoc (#43908) 
* Move postgrest-js docs to tsdoc
(https://github.com/supabase/supabase-js/pull/2177)
* Move realtime-js docs to tsdoc
(https://github.com/supabase/supabase-js/pull/2164)
* Remove entries from yml
 2026-03-23 14:35:40 +02:00
supabase-cli-releaser[bot] 2510f4e7c7 chore: update cli reference doc (#43756) 
Co-authored-by: supabase-cli-releaser[bot] <246109035+supabase-cli-releaser[bot]@users.noreply.github.com>
 2026-03-16 15:04:12 +01:00
supabase-supabase-autofixer[bot]mandariniKaterina Skroumpelou
 		4b388b7bf7 docs: update js sdk docs (v2.94.1) (#42454) 
Updates JS sdk documentation following stable release. 
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `v2.94.1`
- **Source:** `manual`
- **Changes:** Regenerated tsdoc files from latest spec files

🤖 Auto-generated from @supabase/supabase-js stable release.

---------

Co-authored-by: mandarini <6603745+mandarini@users.noreply.github.com>
Co-authored-by: Katerina Skroumpelou <sk.katherine@gmail.com>
 2026-02-04 18:39:59 +02:00
supabase-cli-releaser[bot] 81749e057a chore: update cli reference doc (#42404) 
Co-authored-by: supabase-cli-releaser[bot] <246109035+supabase-cli-releaser[bot]@users.noreply.github.com>
 2026-02-04 13:13:08 +11:00
Illia BasalaievandIllia Basalaiev a184e69f94 chore: cli docs minor grammar update (#42237) 
Co-authored-by: Illia Basalaiev <illiab@IMB3.local>
 2026-01-29 14:44:38 +11:00
Matheus De Souza Alves 56a633ee13 Docs: Fix grammar typo in CLI Reference docs (#41948) 2026-01-19 01:15:00 +00:00
supabase-supabase-autofixer[bot]andphamhieu 031f0ae666 feat: update mgmt api docs (#41976) 
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
 2026-01-19 12:06:30 +11:00
supabase-cli-releaser[bot]andChris Chinchilla 1602abdb34 chore: update cli reference doc (#41002) 
* chore: update cli reference doc

* chore: update cli reference doc

---------

Co-authored-by: supabase-cli-releaser[bot] <246109035+supabase-cli-releaser[bot]@users.noreply.github.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
 2026-01-16 02:50:19 +00:00
TheOtherBrian1 549bd14604 Cli reference doc updates | added examples to the storage section (#41728) 
updated CLI reference doc: added examples for the storage cp command
 2026-01-06 11:22:33 +01:00
Coppleandsupabase-cli-releaser[bot] 065e35fd83 chore: update cli reference doc (#40768) 
* chore: update cli reference doc

* chore: update cli reference doc

---------

Co-authored-by: supabase-cli-releaser[bot] <246109035+supabase-cli-releaser[bot]@users.noreply.github.com>
 2025-12-01 11:44:07 +01:00
github-actions[bot]mandariniKaterina Skroumpelou
 		a0e62693aa docs: update js client libraries (patch) (#40779) 
* docs: update js client libraries (patch)

* docs(storage): update sections and navmenu

* docs: fix broken links in runtime

* docs: update examples

* docs: update snapshot

* docs: fix type return

* docs: updated return and snaps

* docs: fix some rendering reference issues

* docs: surface types

* docs: update examples

* docs: update snapshot

* docs: remove script for gaps analysis

---------

Co-authored-by: mandarini <6603745+mandarini@users.noreply.github.com>
Co-authored-by: Katerina Skroumpelou <sk.katherine@gmail.com>
 2025-11-26 15:51:02 +02:00
Copple 25cd2af2a5 chore: update cli reference doc (#40335) 2025-11-25 09:21:30 +08:00
Copple a963b9bfc0 chore: update cli reference doc (#39943) 2025-11-03 10:37:49 +01:00
github-actions[bot]supabase-releaser[bot]Katerina Skroumpelou
 		6d9176187e docs: update js client libraries (2.78.0) (#40013) 
* docs: update js client libraries (2.78.0)

* fix(docs): add fallback for unhandled schema types in API reference

---------

Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
Co-authored-by: Katerina Skroumpelou <sk.katherine@gmail.com>
 2025-10-31 13:22:10 +02:00
CoppleandQiao Han 6245ba5384 chore: update cli reference doc (#39469) 
* chore: update cli reference doc

* chore: update cli reference doc

* chore: update cli reference doc

* chore: update common sections for cli commands

---------

Co-authored-by: Qiao Han <qiao@supabase.io>
 2025-10-28 05:41:18 +00:00
Copple 13dcb5ef42 chore: update cli reference doc (#39066) 
* chore: update cli reference doc

* chore: update cli reference doc
 2025-10-05 15:12:13 +02:00
Katerina SkroumpelouandCharis Lam b7f1616e3c chore: update docs from js monorepo (#39200) 
* chore: update docs from js monorepo

* chore: remove sparse-checkout for workflow to work

* chore: update workflow with no-frozen-lockfile

* chore(js libs docs update): regenerate typespec snapshot on update

* fix(typespec): fix missing types in transformed typespec

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
 2025-10-03 12:02:53 +03:00
Copple f4149525d5 chore: update cli reference doc (#38942) 2025-09-23 10:37:14 -04:00
Katerina SkroumpelouandCharis Lam a5fc052704 docs: update js client libs docs (#38595) 
* docs: update js client libs docs

* chore: update test snapshot for specs

* ci(docs): run tests on spec changes

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
 2025-09-11 12:14:27 +01:00
Copple 5e60170005 chore: update cli reference doc (#38538) 
* chore: update cli reference doc

* chore: update cli reference doc
 2025-09-10 07:44:12 +00:00
Copple 2b3a79374f chore: update cli reference doc (#38202) 2025-08-26 12:50:24 +08:00
Copple d0c94df957 chore: update cli reference doc (#37859) 2025-08-12 13:42:49 -04:00
github-actions[bot]andphamhieu de80626671 feat: update mgmt api docs (#37652) 
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
 2025-08-04 20:24:33 +00:00
Copple 952698e6e6 chore: update cli reference doc (#37343) 
* chore: update cli reference doc

* chore: update cli reference doc

* chore: update cli reference doc

* chore: update cli reference doc

* chore: update cli reference doc

* chore: update cli reference doc

* chore: update cli reference doc
 2025-08-02 11:25:24 -04:00
CoppleandHan Qiao 203b998780 chore: update cli reference doc (#37142) 
* chore: update cli reference doc

* Apply suggestion from @sweatybridge

---------

Co-authored-by: Han Qiao <sweatybridge@gmail.com>
 2025-07-15 09:49:04 +00:00
Charis 1c2312975b docs: add auth getClaims method (#37122) 2025-07-14 21:13:23 +00:00
Copple b8193041ea chore: update cli reference doc (#36790) 2025-07-02 19:18:40 -04:00
Copple 985304e5ed chore: update cli reference doc (#36454) 2025-06-17 13:58:20 -04:00
Copple ade0e400fa chore: update cli reference doc (#36126) 2025-06-03 11:59:03 +08:00
Lawrence Wang 069c899168 Improve supabase link documentation (#36083) 
Show that its setting is persisted in the filesystem at `supabase/.temp/project_ref`, so developers have a way of seeing what project is currently linked. 

This appears to be otherwise undocumented, and only mentioned in one Github issue and one Reddit comment as far as I can tell.
 2025-06-02 15:46:49 +00:00
Copple 5bc5af2b47 chore: update cli reference doc (#35765) 2025-05-20 11:55:16 +08:00
Copple 22ee5dfe2a chore: update cli reference doc (#35490) 2025-05-06 12:11:42 -04:00
Tyler 7bf04545d8 docs: Add some missing descriptions to the CLI reference docs (#35434) 
* Add description for supabase-config-push

* docs: Add descriptions to a few cli commands and command groups

* delete the unnecessary note about linking a project

* fix/add cli-latest file to gitignore
 2025-05-04 09:28:35 +09:00
Copple 9227e83e56 chore: update cli reference doc (#35258) 2025-04-25 02:37:13 +08:00