Pular para o conteúdo

CLI & Tooling

Um app em execução

Esses comandos comunicam-se com um app em execução por meio de sua própria API, portanto, a segurança em nível de linha (row-level security), o acesso a campos, hooks e políticas de armazenamento decidem o que eles podem fazer, assim como fazem para o SDK. Eles acessam o rebase dev local, um servidor especificado por você ou um projeto do Rebase Cloud, com as mesmas flags em qualquer lugar.

Flag Para onde as requisições vão e como quem
(nenhuma) REBASE_BASE_URL (shell, depois .env), caso contrário o rebase dev que este checkout está executando; com a chave de serviço do .env
--url <server> Aquele servidor, com a chave de serviço do .env
--project <slug> Um projeto do Rebase Cloud, por meio do proxy do Studio do console: você faz login com rebase cloud login, e o plano de controle anexa a chave do app do lado dele, para que nenhuma chave chegue à sua máquina. Proprietários e administradores de organizações, em um projeto cujo acesso ao Studio esteja ativado (rebase cloud settings set --studio on)
--cloud O projeto do Rebase Cloud ao qual este diretório está vinculado
--token <bearer> Envia este bearer: uma chave rk_ ou o token de acesso de um usuário. Em um projeto Cloud, vai para o próprio endereço do app
--session Envia a sessão de pessoa armazenada por rebase auth login para aquele servidor
--anon Não envia nada: o que um visitante recebe

Nada mais é presumido: sem REBASE_BASE_URL e sem um rebase dev em execução, o comando é recusado em vez de enviar a chave de serviço para o que quer que esteja escutando em uma porta. Todos os comandos aceitam --json (e a saída é em JSON sempre que o stdout não for um terminal, assim como o rebase cloud) e --yes, que responde à confirmação solicitada por qualquer comando destrutivo; sem um terminal, ele recusa com confirmation_required em vez de solicitar confirmação.

rebase api-keys, rebase storage orphans|move e rebase schema reconcile aceitam as mesmas flags.

Qualquer rota que o app disponibiliza, com a credencial do projeto — a cauda longa que não possui um comando próprio: a atualização de uma view materializada, a auditoria de RLS, /api/meta/contract, uma rota adicionada por um plugin.

rebase api data/posts -f status=eq.published -f limit=5 # GET /api/data/posts?status=eq.published&limit=5
rebase api POST data/posts -F title=Hello -F published=true
rebase api /api/admin/rls-audit --project acme
rebase api PATCH data/posts/42 --input change.json --include

Um caminho sem uma / inicial fica sob /api. -f key=value é um campo de texto (string) e -F é tipado (true, false, null, números, JSON, @file); os campos compõem a query string de um GET, HEAD ou DELETE e um corpo JSON nos demais casos. Diferente de gh api, um campo por si só nunca transforma a requisição em um POST: uma escrita define explicitamente seu método ou carrega --input. A resposta é exibida exatamente como retornada — JSON formatado — e uma resposta diferente de 2xx é exibida e encerra com código 1. Um cabeçalho Authorization é recusado; as flags de destino escolhem a credencial.

As linhas de uma tabela, por meio de /api/data. Os filtros são os da própria API (?status=eq.published), repassados exatamente como escritos: --where status=eq.published, --where price=gte.10 e um --where status=draft simples para igualdade.

rebase data query posts --where status=eq.published --order-by created_at:desc -n 10
rebase data query orders --all --format csv > orders.csv
rebase data get posts 42 --include author
rebase data count posts --where status=eq.draft
rebase data aggregate orders --select "count(),sum(total)" --group-by status
rebase data insert posts --data '{"title":"Hello"}'
rebase data update posts 42 --data '{"title":"Renamed"}'
rebase data delete posts --where status=eq.draft --yes
rebase data import posts --file seed.csv --upsert slug
rebase data history posts 42 && rebase data revert posts 42 <historyId>
rebase data watch posts --where status=eq.published
Ação Observações
query <table> --where, --or, --order-by col[:desc] (repetível), --limit, --offset, --fields a,b, --include, --search, --deleted include|only; --all percorre todas as páginas; --format table|json|ndjson|csv (csv e ndjson fazem streaming com --all)
get <table> <id> Uma linha, com --fields e --include
count <table> As linhas correspondentes a --where
aggregate <table> --select e --group-by, os próprios da API
insert <table> --data <json> ou --file <path|->; um array representa várias linhas em uma única escrita em lote; --upsert <column>
update <table> [<id>] Uma linha, ou todas as linhas correspondentes a --where após uma contagem e confirmação; --if-match <etag>
delete <table> [<id>] Pede confirmação primeiro; --hard em uma tabela com soft-delete
import <table> --file (array JSON, NDJSON ou CSV por extensão, ou --format), em lotes (--batch); --upsert, --ignore-duplicates. Lê de volta o que query --format json escreve
history <table> <id>, revert <table> <id> <historyId> Tabelas com histórico ativado
watch <table> As linhas correspondentes a cada alteração, via socket em tempo real. Não passa pelo proxy do Studio: em um projeto Cloud, passe --token ou --session

A chave de serviço tem a role admin: a segurança em nível de linha ainda é executada, sob essa role. Passe --token, --session ou --anon para ver a tabela como outra pessoa veria.

As tabelas, ou as colunas, relacionamentos e a segurança em nível de linha de uma tabela — de backend/schema por padrão, ou com --remote (ou qualquer flag de destino) conforme o servidor em execução os descreve para essa credencial. Uma credencial sem schema:read não vê nenhuma política, e uma tabela que ela não puder ler não é listada.

rebase schema show
rebase schema show posts --remote --project acme

As contas, por meio de /api/admin/users, /roles e /guests. Uma conta é identificada por seu uid ou email (uma correspondência exata, nunca o primeiro resultado aproximado).

rebase users list --search ada
rebase users create ada@example.com --role admin
rebase users update bob@example.com --add-role editor
rebase users update bob@example.com --disable
rebase users reset-password bob@example.com
rebase users mfa-reset bob@example.com
rebase users roles
rebase users guests prune --older-than 30d --yes

create envia um convite por email ou retorna uma senha temporária única quando nenhum email puder ser enviado. --no-invite cria a conta sem senha e não envia nada, para um app com login via magic link, código por email ou provedor externo (POST /api/admin/users com invite: false). Conceder uma role, --disable, delete e mfa-reset solicitam confirmação primeiro. Nenhum chamador pode conceder uma role superior à sua própria ou agir sobre uma conta de hierarquia mais alta. rebase auth reset-password é a sintaxe mais antiga e ainda recorre diretamente ao banco de dados quando o servidor não está em execução.

As tarefas agendadas do app (backend/crons/*).

rebase cron list
rebase cron logs nightly-backup -n 5
rebase cron run cleanup-sessions --yes
rebase cron disable nightly-backup --yes
rebase cron reset nightly-backup # the job's code decides again

enable e disable sobrescrevem o código do job em todos os processos, persistindo entre novos deploys; run solicita confirmação antes, e --async responde assim que a execução é iniciada. Em um projeto Cloud, o rebase cron não precisa de acesso ao Studio para leituras: ele solicita ao plano de controle um token de plataforma cron:read de curta duração, que qualquer membro com acesso aos logs possui. run, enable, disable e reset exigem cron:write, que proprietários ou administradores de organizações possuem em projetos com o Studio ativado. rebase cloud cron é a sintaxe mais antiga, apenas de leitura.

Os logs de requisição e de aplicação do servidor — o buffer que o Logs Explorer do Studio lê — exibidos uma vez ou acompanhados em tempo real com -f.

rebase logs -n 50 --level warn
rebase logs -f --source auth --search "sign-in"

O buffer pertence a um único processo. Com --project ou --cloud, este comando atua como rebase cloud logs --runtime: a saída de todas as réplicas, por meio do plano de controle.

As rotas personalizadas do app, uma por arquivo em backend/functions/.

rebase functions list
rebase functions invoke hello --anon
rebase functions invoke billing webhook -X POST --input event.json

invoke aceita os campos, corpo e cabeçalhos que rebase api aceita, e exibe a resposta exatamente como ela veio. As functions decidem seu próprio acesso, portanto a credencial faz diferença: --anon mostra o que um visitante comum recebe.

Arquivos armazenados, por meio das políticas de storage. O lado armazenado começa com dois-pontos: :avatars/me.png na origem padrão, media:avatars/me.png na origem identificada como media.

rebase storage ls :avatars
rebase storage cp ./me.png :avatars/me.png
rebase storage cp :avatars/me.png ./me.png
rebase storage url :avatars/me.png # a signed link: whoever holds it reads the file until it expires
rebase storage stat :avatars/me.png
rebase storage rm :avatars/me.png --yes

cp --public faz o upload sob o prefixo público (uma URL permanente, sem necessidade de token), --content-type define o tipo e --force sobrescreve um arquivo local no download. orphans e move formam a parte do grupo voltada à manutenção de todo o storage.

O que outra identidade veria, a partir do simulador de RLS do app — o mesmo que a opção “view as” do Studio utiliza: por tabela, as linhas que ela lê em comparação com as linhas que você lê, as tabelas das quais seus escopos a bloqueiam e as colunas que ela não pode ler. Apenas leitura.

rebase auth login --email you@example.com
rebase rls simulate --role anon
rebase rls simulate --user 3f0c9a7e-… --table posts
rebase rls simulate --key <api-key-id>
rebase rls options

O simulador responde à sessão do próprio administrador e nunca a uma chave; portanto, isso envia a sessão armazenada por rebase auth login. rebase verify --live verifica as políticas em si, sem levar em consideração uma identidade específica.

Algumas rotas respondem a uma pessoa e nunca a uma máquina: o simulador de RLS, chaves pessoais, aplicação de schema ao vivo. rebase auth login faz login em um app em execução — pelo navegador quando o servidor oferecer login de dispositivo, ou com --email e uma senha (--code para um segundo fator) — e mantém a sessão em ~/.rebase/sessions.json, por servidor, nunca no projeto. auth whoami informa quem o servidor reconhece que você é e os escopos que você possui; auth logout encerra a sessão nele também.

rebase auth login --email you@example.com
rebase auth whoami --session
rebase auth emails --latest --links # the dev mailbox: sign-in, reset and magic-link mail with no SMTP_HOST
rebase auth keys create --name ci --scopes data:read:posts --expires-in 30
rebase auth keys revoke <id> --yes

auth emails lê a caixa de entrada de desenvolvimento que um servidor sem SMTP_HOST mantém em vez de enviar emails; --clear a esvazia. auth keys gerencia suas próprias chaves rk_, que agem em seu nome, restritas aos escopos especificados; o servidor responde a isso apenas quando a tabela auth define auth.personalKeys: true. As chaves de serviço ficam em rebase api-keys, que também recebeu update <id>.

  • Índice de endpoints — todas as rotas que esses comandos acessam e o escopo de que cada uma precisa
  • API REST — a sintaxe de filtro, ordenação e paginação repassada por rebase data
  • rebase cloud — o projeto em si no Rebase Cloud: deploys, ambiente, backups, acesso ao Studio
  • Referência da CLI — todos os outros comandos