@hesed/supabase
v0.3.0
Published
CLI for Supabase API interaction
Downloads
216
Readme
supabase
CLI for Supabase API interaction
Install
sdkck plugins install @hesed/supabaseUsage
$ npm install -g @hesed/supabase
$ spb COMMAND
running command...
$ spb (--version)
@hesed/supabase/0.3.0 linux-x64 node-v24.14.1
$ spb --help [COMMAND]
USAGE
$ spb COMMAND
...Commands
spb supabase auth addspb supabase auth testspb supabase auth updatespb supabase create TABLE DATAspb supabase delete TABLEspb supabase query TABLE SELECTspb supabase table-columns TABLEspb supabase tablesspb supabase update TABLE DATA
spb supabase auth add
Add a Supabase connection
USAGE
$ spb supabase auth add --token <value> --url <value> [--json]
FLAGS
--token=<value> (required) API Token:
--url=<value> (required) Supabase API URL:
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Add a Supabase connection
EXAMPLES
$ spb supabase auth addSee code: src/commands/supabase/auth/add.ts
spb supabase auth test
Test Supabase authentication and connection
USAGE
$ spb supabase auth test [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Test Supabase authentication and connection
EXAMPLES
$ spb supabase auth testSee code: src/commands/supabase/auth/test.ts
spb supabase auth update
Update existing Supabase authentication
USAGE
$ spb supabase auth update --token <value> --url <value> [--json]
FLAGS
--token=<value> (required) API Token:
--url=<value> (required) Supabase API URL:
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Update existing Supabase authentication
EXAMPLES
$ spb supabase auth updateSee code: src/commands/supabase/auth/update.ts
spb supabase create TABLE DATA
Insert row(s) into a Supabase database table
USAGE
$ spb supabase create TABLE DATA [--format json|toon] [--schema <value>] [--select <value>] [--toon]
ARGUMENTS
TABLE Table name
DATA JSON object or array of objects to insert
FLAGS
--format=<option> [default: json] Output format
<options: json|toon>
--schema=<value> PostgREST schema name
--select=<value> Comma-separated columns to return after insert
--toon Format output as toon
DESCRIPTION
Insert row(s) into a Supabase database table
EXAMPLES
$ spb supabase create users '{"name":"Alice","email":"[email protected]"}'
$ spb supabase create users '[{"name":"Alice"},{"name":"Bob"}]'
$ spb supabase create products '{"name":"Widget","price":9.99}' --select id,nameSee code: src/commands/supabase/create.ts
spb supabase delete TABLE
Delete row(s) from a Supabase database table
USAGE
$ spb supabase delete TABLE --filters <value> [--schema <value>] [--select <value>] [--toon]
ARGUMENTS
TABLE Table name
FLAGS
--filters=<value> (required) PostgREST filter string (e.g. "id=eq.42")
--schema=<value> PostgREST schema name
--select=<value> Comma-separated columns to return after delete
--toon Format output as toon
DESCRIPTION
Delete row(s) from a Supabase database table
EXAMPLES
$ spb supabase delete users --filters "id=eq.42"
$ spb supabase delete orders --filters "status=eq.cancelled&created_at=lt.2024-01-01"
$ spb supabase delete sessions --filters "user_id=eq.5" --select id
FLAG DESCRIPTIONS
--filters=<value> PostgREST filter string (e.g. "id=eq.42")
format: <column>=<operator>.<value>, combine multiple filters with & (AND)
comparison: eq, neq, gt, gte, lt, lte
pattern: like (case-sensitive, use * as wildcard), ilike (case-insensitive)
regex: match (~), imatch (~*)
list: in.(v1,v2), not.in.(v1,v2)
bool: is.null, is.true, is.false
logic: or=(col1.op.val,col2.op.val), not.<op>.<val>
array: cs.{v1,v2} (contains), cd.{v1,v2} (contained by)
full-text: fts.query, plfts.query, phfts.query, wfts.querySee code: src/commands/supabase/delete.ts
spb supabase query TABLE SELECT
Execute query on Supabase database table
USAGE
$ spb supabase query TABLE SELECT --filters <value> [--limit <value>] [--schema <value>] [--toon]
ARGUMENTS
TABLE Table name
SELECT Columns to return in the result
FLAGS
--filters=<value> (required) PostgREST filter string (e.g. "age=gte.18&status=eq.active")
--limit=<value> Max rows to return
--schema=<value> PostgREST schema name
--toon Format output as toon
DESCRIPTION
Execute query on Supabase database table
EXAMPLES
$ spb supabase query users first_name,last_name,email --filters "created_at=gt.2017-01-01"
$ spb supabase query users id,email --filters "age=gte.18&status=eq.active"
$ spb supabase query products name,price --filters "name=ilike.*phone*"
$ spb supabase query orders id,total --filters "status=in.(pending,processing)&total=gte.100"
$ spb supabase query posts id,title --filters "or=(author_id.eq.5,featured.is.true)"
$ spb supabase query events id,name --filters "tags=cs.{sale,featured}"
$ spb supabase query articles id,title --filters "body=fts.climate%20change"
FLAG DESCRIPTIONS
--filters=<value> PostgREST filter string (e.g. "age=gte.18&status=eq.active")
format: <column>=<operator>.<value>, combine multiple filters with & (AND)
comparison: eq, neq, gt, gte, lt, lte
pattern: like (case-sensitive, use * as wildcard), ilike (case-insensitive)
regex: match (~), imatch (~*)
list: in.(v1,v2), not.in.(v1,v2)
bool: is.null, is.true, is.false
logic: or=(col1.op.val,col2.op.val), not.<op>.<val>
array: cs.{v1,v2} (contains), cd.{v1,v2} (contained by)
full-text: fts.query, plfts.query, phfts.query, wfts.querySee code: src/commands/supabase/query.ts
spb supabase table-columns TABLE
List all columns in a table in Supabase database
USAGE
$ spb supabase table-columns TABLE [--schema <value>] [--toon]
ARGUMENTS
TABLE Table name to get columns
FLAGS
--schema=<value> PostgREST schema name
--toon Format output as toon
DESCRIPTION
List all columns in a table in Supabase database
EXAMPLES
$ spb supabase table-columnsSee code: src/commands/supabase/table-columns.ts
spb supabase tables
List all tables in Supabase database
USAGE
$ spb supabase tables [--schema <value>] [--toon]
FLAGS
--schema=<value> PostgREST schema name
--toon Format output as toon
DESCRIPTION
List all tables in Supabase database
EXAMPLES
$ spb supabase tablesSee code: src/commands/supabase/tables.ts
spb supabase update TABLE DATA
Update row(s) in a Supabase database table
USAGE
$ spb supabase update TABLE DATA --filters <value> [--schema <value>] [--select <value>] [--toon]
ARGUMENTS
TABLE Table name
DATA JSON object with fields to update
FLAGS
--filters=<value> (required) PostgREST filter string (e.g. "id=eq.42")
--schema=<value> PostgREST schema name
--select=<value> Comma-separated columns to return after update
--toon Format output as toon
DESCRIPTION
Update row(s) in a Supabase database table
EXAMPLES
$ spb supabase update users '{"status":"active"}' --filters "id=eq.42"
$ spb supabase update products '{"price":19.99}' --filters "name=eq.Widget" --select id,name,price
$ spb supabase update orders '{"status":"shipped"}' --filters "status=eq.pending&total=gte.100"
FLAG DESCRIPTIONS
--filters=<value> PostgREST filter string (e.g. "id=eq.42")
format: <column>=<operator>.<value>, combine multiple filters with & (AND)
comparison: eq, neq, gt, gte, lt, lte
pattern: like (case-sensitive, use * as wildcard), ilike (case-insensitive)
regex: match (~), imatch (~*)
list: in.(v1,v2), not.in.(v1,v2)
bool: is.null, is.true, is.false
logic: or=(col1.op.val,col2.op.val), not.<op>.<val>
array: cs.{v1,v2} (contains), cd.{v1,v2} (contained by)
full-text: fts.query, plfts.query, phfts.query, wfts.querySee code: src/commands/supabase/update.ts
