Referência
Comandos de terminal
A CLI faundr vem junto com o plugin. É ela que o agente usa por baixo dos comandos /faundr:…, e você também pode usá-la direto. Esta página lista todos os comandos, agrupados por assunto.
Como rodar um comando
Você pode rodar um comando do Faundr de três jeitos:
- Dentro do Claude Code, com
!na frente:!faundr board. O comando roda na hora e a resposta fica na conversa, então o agente também a vê. - Pedindo ao agente: "registre a tarefa X no Faundr". Ele roda o comando certo sozinho.
- Num terminal comum, na pasta do projeto:
faundr board. Para isso, o plugin precisa estar instalado e ofaundrprecisa estar no caminho do terminal. Dentro do agente ele já está.
Algumas regras valem para todos os comandos:
- Texto sem aspas funciona.
faundr task Criar a tela de loginé o mesmo quefaundr task "Criar a tela de login". Use aspas quando o texto tiver símbolos que o terminal entende de outro jeito (|,>,&). - Opções usam espaço, não
=. Escreva--days 30. A forma--days=30não funciona. - A maioria precisa de login e de uma pasta ligada. Sem login, aparece "Sem token. Faça o login primeiro". Sem pasta ligada, aparece "Pasta não ligada a um projeto. Use /faundr:link primeiro". As exceções estão marcadas como funciona sem internet.
- A CLI não usa o seu plano de IA. O que ela faz é análise local, sem IA, ou montar o contexto para o agente ler. A parte que pensa é feita pelo agente, guiado pelos comandos do agente. A única exceção é o
faundr browse, em que o Jev, um serviço de fora, escolhe os cliques.
faundr --help (ou qualquer nome que a CLI não conhece) mostra só a lista com os nomes dos comandos, sem explicar cada um. Use esta página como referência.Conta e conexão
| Comando | O que faz |
|---|---|
faundr setup [--refresh] | Configura o Faundr no projeto de uma vez, como o /faundr:setup: faz o que é seguro e, num terminal comum, pergunta sim ou não a cada item que mexe em arquivos do projeto. Mostra também o que gasta IA, com o custo estimado. --refresh refaz o mapa e as checagens. Outras opções: --apply <itens> e --skip <itens> (aplicar ou deixar de fora sem perguntar: git, gitignore, statusline, agents-md, codex-rules, supabase-token, errors), --no-ask (só mostra), --economy all e --no-economy (liga ou desliga o modo econômico do fim da resposta). |
faundr login [--url <endereço>] | Conecta o computador à sua conta pelo navegador: mostra um código, abre o Faundr e espera você clicar em Autorizar (até 5 minutos; se passar, faundr login --wait continua). O token é criado no computador e não passa pelo chat. --url só serve para apontar para outro servidor do Faundr. |
faundr link [<nome ou id do projeto>] | Liga a pasta atual a um projeto. Aceita o nome exato (maiúsculas não importam) ou o id. Sem nada, lista os projetos que você pode ligar. Grava o arquivo .faundr.json na pasta. |
faundr status | Mostra se está tudo conectado: servidor em uso, início do token, projeto ligado, branch do git, se o mapa do código existe e onde fica o registro de erros do plugin. Funciona sem internet. |
faundr config lang [en|pt|auto] | Escolhe a língua do que o plugin mostra para você (setup, barra de status, achados no painel). Sem nada, mostra a atual. auto volta para a língua do computador. O agente sempre conversa na língua em que você escreve. |
faundr statusline-install [--force] | Liga a barra de status do Faundr no rodapé do Claude Code (projeto, funcionalidade, progresso, próximo passo). Não troca uma barra que você já tenha, a não ser com --force. |
faundr agents-md [--file <arquivo>] [--off] [--sync] | Copia as regras e decisões do time para o AGENTS.md (ou outro arquivo, como o CLAUDE.md), num bloco marcado. Serve para agentes que não rodam o plugin, como o Cursor, verem a memória do time. Vem desligado. --off tira o bloco. Depois de ligado, o bloco se atualiza sozinho a cada sessão. |
O Faundr encontra o projeto subindo de pasta em pasta até achar o
.faundr.json. A pasta onde ele está é a raiz do projeto para o Faundr. Se você ligar a pasta errada, rode faundr link de novo na pasta certa.Funcionalidades e tarefas
Registram o que está sendo construído. Tudo aparece em Funcionalidades e na barra de status.
| Comando | O que faz |
|---|---|
faundr feature "<título>" [--desc "..."] [--done-when "a; b"] | Cria uma funcionalidade e a torna a atual desta pasta. --done-when define o critério de pronto, com os itens separados por ;. |
faundr feature "<etapa>" --after atual [--desc "..."] | Registra a próxima etapa de um trabalho feito em fases. Ela fica planejada e não vira a atual. Em --after vale atual ou o nome (ou um trecho) da etapa anterior. |
faundr task "<descrição>" [--feature "<nome>"] | Acrescenta uma tarefa ao checklist da funcionalidade atual, ou da indicada. |
faundr start "<trecho ou nº>" | Marca uma tarefa como em andamento. |
faundr done "<trecho ou nº>" [--already-committed] | Marca uma tarefa como concluída e guarda o commit atual. Se houver mudanças fora de commit, a tarefa aparece como sem commit no painel até o próximo git commit. --already-committed é para trabalho antigo, que já está no git: as mudanças de agora não contam. |
faundr focus "<nome>" | Troca a funcionalidade atual e mostra o checklist dela. |
faundr board [--all | --memory | --review] | Mostra as preocupações abertas e o checklist da funcionalidade atual. --all mostra todas as funcionalidades. --memory mostra só as regras e decisões confirmadas. --review mostra tudo o que está aberto (em andamento e próximas etapas), com quando foi mexido pela última vez e o que está parado há mais de 14 dias: é o que o /faundr:tidy-board lê. |
faundr feature-discard "<id ou nome>" | Descarta uma funcionalidade que não vai mais ser feita. Ela sai das abas e do contexto do agente, mas dá para trazer de volta. |
faundr feature-restore "<id ou nome>" | Traz de volta uma funcionalidade descartada (o mesmo que o botão Restaurar no painel). |
faundr criteria ["<critério>"] [--feature "<nome>"] | Sem texto, lista o critério de pronto e a situação de cada item. Com texto, acrescenta um item. |
faundr criteria --remove <nº> | Tira um item do critério de pronto da funcionalidade atual (por exemplo, um que entrou errado). |
faundr criteria-check <nº> --met | --not-met [--note "..."] | Marca um item do critério de pronto como atendido ou não, com uma nota de como foi conferido. |
Memória: regras, decisões e preocupações
Tudo aparece em Memória.
| Comando | O que faz |
|---|---|
faundr decision "<decisão>" [--why "<porquê>"] [--file "<arquivos>"] [--replaces "<id ou trecho>"] [--global] | Registra uma decisão técnica, ligada à funcionalidade atual. Sem --file, ela se liga sozinha aos arquivos que a sessão editou (quando são até 5); --global evita isso. --replaces aposenta a decisão que esta substitui. Se ela parece com outra, o comando avisa. |
faundr rule "<regra>" [--why "..."] [--file "<arquivos>"] [--forbid "<padrão>"] | Registra uma regra do time. --forbid diz o que o código não pode ter, por exemplo "console\.log\(". Aí o Faundr avisa o agente a cada edição que traga o padrão, e a checagem de qualidade aponta onde ele já existe. |
faundr memory-edit "<id ou trecho>" [--rule | --decision] [--file "<arquivos>"] [--global] [--obsolete] | Muda uma regra ou decisão: vira regra (vale sempre) ou decisão, liga a arquivos, volta a valer para o projeto todo ou fica obsoleta. Os ids aparecem em faundr board --memory. |
faundr concern "<o que preocupa>" [--why "..."] | Registra uma preocupação para revisar depois. Ela ganha um número (P-1, P-2…). |
faundr resolve [P-<n>] | Marca uma preocupação como resolvida. Sem número, lista as abertas. |
Em --file vale um arquivo, uma pasta ou um padrão como src/server/** ou *.sql, e a opção pode se repetir.
Visão, Stack e variáveis
| Comando | O que faz |
|---|---|
faundr stack-scan [--json] | Lê os arquivos do projeto sem IA e detecta onde cada parte roda, linguagens, ferramentas, serviços externos, variáveis (só os nomes) e scripts. --json mostra o resultado sem enviar. Roda sozinho no início de cada sessão. |
faundr env-check [--hosting] [--no-send] | Confere cada variável de ambiente: o código lê? está no arquivo de exemplo? está no .env do computador? está na hospedagem? Aponta o que "quebra no ar", o que "falta no computador" e o que está "fora do exemplo". Só nomes, nunca valores. --hosting consulta a Cloudflare, a Vercel ou a Netlify pela CLI delas, que precisa estar logada. |
faundr overview-context / overview-save | Usados pelo /faundr:overview para escrever a Visão. Você não precisa rodar. |
faundr diagram-save [arquivo] [--feature "<nome>"] [--no-wait] | Usado pelo /faundr:planning para enviar o diagrama "como vai funcionar" de uma funcionalidade: o servidor confere o formato, o canvas abre no seu navegador e o comando espera você aprovar ou pedir mudanças. Você não precisa rodar. |
faundr diagram-wait [--feature "<nome>"] | Continua esperando a sua resposta no canvas do desenho (o agente usa quando você demora mais de 9 minutos). |
faundr architecture-check | Confere quais partes da arquitetura (seção Arquitetura) já existem no código, pelos caminhos de cada parte, e quais pastas com código ficaram fora do plano, e manda ao painel. Roda sozinho no início de cada sessão, sem IA. Com --pull, grava a arquitetura atual em .faundr/painel/architecture.json para o agente editar e enviar com faundr diagram-save … --architecture. |
faundr stack-context / stack-save | Usados pelo /faundr:stack para revisar a Stack. Você não precisa rodar. |
Mapa do código
O mapa é montado no seu computador. As consultas funcionam sem internet e sem login: elas leem o mapa local e, antes de responder, atualizam só os arquivos que mudaram.
| Comando | O que faz |
|---|---|
faundr map [pergunta] | Sem nada, o mesmo que faundr graph; com uma pergunta, o mesmo que faundr graph-query. |
faundr graph | Gera o mapa do código (ou refaz) e envia ao painel. Depois da primeira vez, ele se refaz sozinho quando o agente edita arquivos. |
faundr graph-query "<pergunta>" [--limit N] [--budget N] | Pergunta ao mapa. Devolve até 8 trechos de código relevantes, com quem os usa e o que eles usam. |
faundr graph-path "A" "B" | Como duas peças do projeto se conectam. Sem caminho na direção de uso, tenta ignorando a direção uma vez; nunca passa por pacotes de fora (como react ou node:fs). |
faundr graph-callers "X" [--out | --both] [--depth 2] | Quem usa X. --out mostra o contrário (o que X usa); --both, os dois. --depth 2 mostra o efeito em cadeia. |
faundr graph-skeleton <arquivo> | O resumo de um arquivo: cada função com o cabeçalho, sem o corpo. |
faundr graph-grep "<texto>" [--in <pasta>] [-i] | Procura um texto e agrupa os resultados pela função onde aparecem, as mais usadas primeiro. -i ignora maiúsculas. |
Segurança
Os achados são numerados S-n e aparecem em Segurança. A checagem roda no computador e envia só os achados, com as chaves mascaradas.
| Comando | O que faz |
|---|---|
faundr security-scan [--files a,b] [--history] | Checagem completa sem IA: chaves e senhas no código, .env no git, regras do banco, pacotes com falha conhecida, limites e cabeçalhos. --history também procura chaves no histórico do git, o que já acontece sozinho uma vez por semana. |
faundr security-show [S-<n> | <pacote>] | Sem nada, lista os problemas abertos por gravidade e, à parte, os "A conferir". Com S-n, mostra os detalhes do problema e como resolver. Com o nome de um pacote, mostra todos os problemas dele. |
faundr security-resolve S-<n> [--verified "..."] | Refaz a checagem e só fecha se o problema sumiu de verdade. Achado da revisão com IA pede --verified dizendo como foi conferido. |
faundr security-ignore S-<n> --reason nao-e-problema|aceito-o-risco [--note "..."] [--days N | --days sempre] | Tira da lista com um motivo. O padrão é por 30 dias: depois disso, o achado volta. |
faundr security-report [--out arquivo.md] | Gera o relatório de segurança em Markdown, para mostrar a um sócio ou colar numa IA. |
faundr security-import <arquivo> | Importa resultados de outra ferramenta: Snyk (snyk test --json), qualquer arquivo SARIF (Semgrep, CodeQL, Gitleaks, Trivy…) ou o Security Advisor do Supabase. |
faundr security-supabase [--ref <projeto>] | Roda o Security Advisor do Supabase no banco de verdade. Precisa do seu token pessoal do Supabase na variável SUPABASE_ACCESS_TOKEN, que fica só no computador. |
Banco, lançamento e LGPD
| Comando | O que faz |
|---|---|
faundr db-test [--sql | --result <arquivo>] | Testa o banco Supabase como visitante e como outra pessoa logada. A leitura usa a chave pública do .env. Para testar gravar, alterar e apagar, ele precisa do SUPABASE_ACCESS_TOKEN. Sem o token, --sql mostra o SQL de teste para o agente rodar pelo Supabase, e --result traz a resposta de volta. O teste desfaz tudo no fim. Cada porta aberta vira um S-n. |
faundr launch-check [--url <site>] [--skip-code] | A parte do "Pronto para lançar?" que só o computador confere: o código compila, testes, segurança, banco testado, webhook de pagamento, cabeçalhos do site no ar, limite de pedidos e política de privacidade. Termina com CAN LAUNCH: YES/NO. Sem --url, usa o endereço de produção da Stack; --skip-code pula build, testes e segurança. |
faundr privacy | Inventário sem IA dos dados pessoais que o app coleta e das empresas que recebem esses dados, e o que falta para a LGPD. Não lê dados de usuários, só nomes de campos, colunas e pacotes. |
Qualidade do código
Os achados são numerados Q-n e aparecem em Qualidade do código.
| Comando | O que faz |
|---|---|
faundr quality-scan [--files a,b] | Checagem completa sem IA: falha escondida, tipo fraco, complicado demais, código demais, limpeza, testes pulados, instruções da IA quebradas, desempenho e as regras da casa. |
faundr quality-show [Q-<n>] | Lista os abertos, ou mostra um com o que é, por que importa e como resolver. |
faundr quality-resolve Q-<n> [--verified "..."] | Refaz a checagem e só fecha se o problema sumiu. |
faundr quality-ignore Q-<n> --reason falso-alarme|de-proposito|depois [--note "..."] | Tira da lista com um motivo. depois volta sozinho em 30 dias. |
faundr quality-reopen Q-<n> | Reabre um achado ignorado. |
faundr quality-rule "<nome>" --pattern "<padrão>" --message "<por quê>" [--files "src/**"] [--severity alta|media|baixa] | Cria uma regra da casa: algo que o time não quer ver no código. Vira um arquivo em .faundr-regras/, que vai para o git com o resto do projeto. |
faundr quality-ladder on|off | Liga ou desliga o lembrete para o agente não escrever código demais, no início de cada sessão. |
Para pular um trecho de propósito, escreva um comentário na linha de cima:
// faundr-ignore <regra>: <motivo>. faundr-ignore-file <regra> vale para o arquivo inteiro.Testes
Os testes nunca rodam sozinhos: só quando você ou o agente pedem. Veja Testes.
| Comando | O que faz |
|---|---|
faundr tests-scan | Inventário sem rodar nada: quais executores o projeto usa (Vitest, Jest, Playwright, node --test, pytest, Karma, flutter test, PHPUnit, Pest, go test, Maven, Gradle, dotnet test, cargo test, CTest, make test), quantos arquivos e testes existem e se algum teste parece usar o banco de produção. Roda sozinho no início da sessão. |
faundr tests-run [--changed] [--coverage] [--files a,b] [--runner <nome>] | Roda os testes e envia o resultado. --changed roda só o que mudou desde o último commit. --coverage mede também quanto do código tem teste. Outras opções: --exclude, --timeout <minutos> e --python <caminho>. |
faundr tests-show [T-<n>] | As últimas rodadas e os testes falhando ou instáveis. Com T-n, um defeito do teste de mutação. |
faundr tests-mutation [--files <arquivo>] [--budget <min>] | Teste de mutação: estraga o código de propósito, só no que a sessão mudou, e mostra cada estrago que nenhum teste percebeu (vira um T-n). Precisa do Stryker instalado e dos testes passando. O padrão é 5 minutos. |
faundr tests-ignore T-<n> --reason equivalente|falso-alarme|depois | Tira um defeito da lista com motivo. |
faundr tests-map "<funcionalidade>" [--tests "a.test.ts"] [--critical] | Liga uma funcionalidade aos testes que a protegem. --critical marca como "não pode quebrar". |
Se os testes parecerem usar o banco de produção, o
tests-run e o tests-mutation não rodam até receber --confirm-db. O caminho seguro é ter um .env.test apontando para um banco de teste.O Faundr nunca instala nada sozinho. Se faltar a ferramenta de cobertura (
@vitest/coverage-v8) ou o Stryker, ele mostra o comando para você aprovar.Design
Os achados são numerados D-n e aparecem em Design.
| Comando | O que faz |
|---|---|
faundr design-lint | Checagem sem IA das telas (cerca de 45 regras): identidade, celular, acessibilidade, contraste, movimento, estados, cores fora da paleta e estilos repetidos. Roda sozinho. |
faundr design-show [D-<n>] | Sem número, mostra a ordem de correção dos abertos em 5 etapas, do que quebra o uso até o polimento. Com número, mostra os detalhes. |
faundr design-resolve [D-<n>] | Marca como resolvido. Sem número, lista os abertos. |
faundr design-archive D-<n> --reason nao-se-aplica|falso-alarme|decisao-de-design --note "..." | Arquiva um problema que não vale para este projeto, com o motivo. Não volta. |
faundr design-reopen D-<n> | Reabre um achado arquivado ou resolvido. |
faundr design-scope [--mobile sim|desktop|celular] [--product app|site|misto] [--theme escuro|claro|ambos] [--motion nenhum|sobrio|expressivo] [--disable <regra>] [--enable <regra>] [--exception "técnica — motivo"] | Mostra ou muda o escopo do design. --mobile desktop para de verificar a versão de celular. Desligar uma regra arquiva os achados abertos dela. |
faundr design-coverage | Mostra a cobertura da última auditoria completa: o que foi verificado e a nota de cada tema. |
Erros
Os erros são numerados E-n e aparecem em Erros. Os erros dos comandos do agente chegam sozinhos e fecham sozinhos quando o mesmo comando volta a passar.
| Comando | O que faz |
|---|---|
faundr errors [--all | --resolved | --archived] | Lista os erros abertos (ou todos, os resolvidos, os arquivados). |
faundr error-show E-<n> | Onde quebrou, quantas vezes, em que conversa e pedido nasceu e o trecho da saída. Para erros do app publicado, mostra também quantas pessoas foram afetadas, o que elas fizeram antes e o código original (pelos source maps do seu computador). |
faundr error-resolve E-<n> --verified "como conferiu" [--next-deploy] | Fecha à mão. --next-deploy é para erro do app publicado: a versão antiga ainda pode mandar o erro sem reabri-lo, e ele só volta se aparecer numa versão nova. |
faundr error-recipe E-<n> --cause "por que quebrou" --fix "o que consertou" | Guarda a receita do erro. Ela aparece no faundr error-show quando esse erro volta ou quando o mesmo erro surge em outro arquivo do projeto. |
faundr parallel [open "<a>; <b>" | close <nome> | --all] | Sem nada, lista as etapas que já podem começar em paralelo. open abre uma mesa (cópia do projeto em .faundr/mesas/) para cada etapa; close fecha, e só apaga a mesa se o trabalho já foi juntado. Quem usa é o /faundr:parallel. |
faundr error-archive E-<n> [--days N | --count N | --users N] | Arquiva por N dias, até acontecer mais N vezes ou até afetar mais N pessoas. |
faundr error-reopen E-<n> | Reabre um erro. |
faundr errors-dsn | Mostra o endereço (DSN) que o app publicado usa para mandar erros ao Faundr e quando chegou o último. |
faundr errors-uptime <https://site> | --off | Confere se o site está no ar a cada 5 minutos. Duas falhas seguidas viram um erro com aviso, que fecha sozinho quando o site volta. |
faundr errors-import-sentry --org <org> --project <projeto> | Traz os erros abertos do Sentry, para quem já usa. O token (SENTRY_AUTH_TOKEN) fica só no computador. |
Pontos de volta
Estes comandos funcionam sem internet e sem login. Eles só precisam de git na pasta. Veja Proteção contra desastres.
| Comando | O que faz |
|---|---|
faundr checkpoint ["motivo"] | Salva um ponto de volta dos arquivos agora. O Faundr já salva pontos sozinho: antes da primeira mudança de cada sessão, a cada 30 minutos de edições e antes de comandos arriscados. |
faundr checkpoints [--limit N] | Lista os pontos de volta (o 1 é o mais recente) e o que mudou depois de cada um. |
faundr restore <nº> [--yes] | Sem --yes, só mostra o que mudaria. Com --yes, salva o estado atual como um ponto novo e então volta os arquivos. Por isso a volta também pode ser desfeita, com faundr restore 1 --yes. |
Time
| Comando | O que faz |
|---|---|
faundr team | Mostra quem mais está trabalhando no projeto agora: o agente de cada pessoa, o computador, a mesa de trabalho e os arquivos que ela mexeu na última hora. Veja Trabalhar em time. |
faundr claim "<tarefa>" [--force] | Você vira o responsável pela tarefa (aparece com o seu nome no painel). Se ela já for de outra pessoa, avisa e não pega; --force pega mesmo assim, depois de combinar. |
faundr release "<tarefa>" | Deixa a tarefa livre para qualquer pessoa pegar. |
faundr own ["<funcionalidade>"] [--force] | Você vira o dono da funcionalidade (sem nome, a atual). Se ela já for de outra pessoa, avisa e não troca; --force troca mesmo assim, depois de combinar. |
faundr disown ["<funcionalidade>"] | Deixa a funcionalidade sem dono; quem mexer nela primeiro vira o dono. |
faundr inbox | Busca os pedidos do painel para você (ou para qualquer pessoa), os recados e as notas do time. |
faundr inbox --done <código> ["o que foi feito"] | Fecha um pedido; ele aparece como feito no painel, com a nota. |
faundr inbox --print <código> | Baixa o print do pedido feito pela extensão do Chrome (o elemento que a pessoa apontou na tela) para .faundr/pedidos/. |
faundr msg "<texto>" [--to "<nome>"] | Manda um recado para uma pessoa do time (ou, sem --to, para o time todo). Chega no próximo pedido de quem estiver com o agente aberto. |
Skills e workflows
Veja Workflows.
| Comando | O que faz |
|---|---|
faundr skills scan | Lê as skills que você usa neste projeto (as do repositório em .claude/skills e .agents/skills, as pessoais e as dos plugins ligados, no Claude Code e no Codex) e conecta ao Faundr. Lê só o nome, a descrição e se a skill é manual; o conteúdo não sai do computador. Roda sozinho no início de cada sessão e só envia quando a lista mudou. |
faundr skills list | As skills do projeto, por origem, com quando usar, os assuntos e se é uma skill conectada. |
faundr skills when "<nome>" [--when "..."] [--topic "..."] [--kind seguranca|testes|qualidade|erros|nenhum] | Grava quando usar a skill, os assuntos que lembram o agente dela e o tipo. Com um tipo diferente de nenhum, ela vira uma skill conectada: o que ela acha vai para a seção daquele tipo no painel. |
faundr workflow list | Os workflows do projeto (W-n), com a situação: ativo, rascunho ou desligado. |
faundr workflow show <W-n ou nome> | Os passos de um workflow. |
faundr workflow draft "<nome>" --when "..." --topic "..." --step "..." [--file "<pasta ou padrão>"] | Grava um workflow como rascunho. Ele só vale depois que o dono aprova no painel. |
faundr workflow run <W-n> --why "<pedido>" | Começa a seguir um workflow. O time vê o andamento no canvas, ao vivo. |
faundr workflow step <W-n> <nº> [--wait | --skip | --done] [--note "..."] | Marca o passo atual. --wait mostra que é a vez do dono; --skip, que o passo não se aplica. |
faundr workflow done <W-n> [--note "..."] / faundr workflow stop <W-n> | Conclui ou para o workflow. |
| Comando | O que faz |
|---|---|
faundr browse --url <endereço> --goal "<objetivo>" [--value "<texto>"] [--secret-env <VARIÁVEL>] | Faz uma tarefa num site: o Jev, um serviço de fora, escolhe cada clique lendo a lista de botões e campos da página, sem print. O que precisa ser digitado vai em --value; senha vai numa variável de ambiente, com --secret-env, e o Jev só vê "senha informada". Abre um Chrome escondido, com um perfil próprio, sem as suas contas. --show mostra a janela. --chrome usa o seu próprio Chrome, com os seus logins, pela extensão do Faundr. --shot <arquivo.png> salva o print da tela final e --style mede fontes, cores e cantos da página. Não precisa de pasta ligada. |
faundr browse-key --env <VARIÁVEL> | Guarda a chave do Jev em ~/.faundr/config.json, lida de uma variável de ambiente (ou da entrada padrão), para ela não aparecer no comando. |
Sessão, passagem e relatórios
| Comando | O que faz |
|---|---|
faundr resume | "Onde paramos": a sessão anterior (pedidos, commits, tarefas, bilhete) e tudo o que está em aberto no projeto. |
faundr handoff "<bilhete>" | Salva o bilhete de passagem: de 1 a 3 frases sobre o que ficou pela metade e o que vem depois. Aparece em Atividade → Onde parei e no início da próxima sessão. |
faundr handover [--out arquivo.md] | Gera o pacote de passagem para um dev: um documento só com tudo o que alguém precisa para assumir o projeto. O padrão é .faundr/relatorios/PASSAGEM.md. |
faundr weekly | O resumo dos últimos 7 dias em linguagem simples, o mesmo que vai para o Slack ou Discord. |
faundr usage --debug | Mostra os números de uso que o Insights receberia da conversa mais recente. Serve para conferir o que é enviado. |
Variáveis de ambiente
| Variável | Para que serve |
|---|---|
FAUNDR_TOKEN | Usa este token no lugar do salvo pelo faundr login. Útil em servidores de CI: faça o login num computador e use o token do config.json (guarde como segredo do CI, nunca no código). |
FAUNDR_API_URL | Usa este servidor do Faundr no lugar do salvo. |
SUPABASE_ACCESS_TOKEN | Seu token pessoal do Supabase, para security-supabase e db-test. Nunca vai para o Faundr. |
SENTRY_AUTH_TOKEN | Token do Sentry, para errors-import-sentry. Nunca vai para o Faundr. |
TYPESAFE_API_KEY | A chave do Jev, para o faundr browse. Vale no lugar da salva pelo faundr browse-key. |
Arquivos que o Faundr cria
No seu computador, na pasta ~/.faundr/:
config.json: o token e o endereço do servidor. Só você consegue ler.hook.log: o registro de erros do plugin. Se algo do Faundr parecer não funcionar, a explicação costuma estar aqui.browse-profile/: o perfil do Chrome que ofaundr browseusa, separado do seu.- Marcas temporárias da sessão, apagadas depois de 2 dias.
No projeto:
.faundr.json: a ligação da pasta com o projeto. Pode ir para o git..faundr/: tudo o que o Faundr guarda neste computador, separado por tipo. Fica fora do git: o time vê pelo painel. OLEIA-ME.mdda pasta explica cada parte:painel/: cópias locais da Visão, da Stack, da Vitrine, da memória e das regras por arquivo.relatorios/: o pacote de passagem (PASSAGEM.md) e o relatório de segurança.mapa/: o mapa do código e o resumo da arquitetura.verificacoes/: resultados do teste do banco, das variáveis da hospedagem e dos testes do projeto.cache/: atalhos para refazer o mapa mais rápido. Pode apagar.pedidos/: os prints dos pedidos feitos pela extensão do Chrome.state.json: o estado da sessão.DESIGN.md: o guia de design, na raiz do projeto. Vai para o git..faundr-regras/: as regras da casa da Qualidade. Feitas para ir para o git..faundrignore: você cria, se quiser. Lista pastas ou arquivos, um por linha, no formato do.gitignore, que o Faundr deixa de fora do mapa do código, do "Fora do plano" da arquitetura, da checagem de design e da busca das partes do projeto (como um app dentro de outra pasta, com pacotes e scripts próprios). Serve para código de terceiros, repositórios clonados para consulta e arquivos gerados.
No git: os pontos de volta ficam numa área própria (refs/faundr/checkpoints). Eles não mexem na sua branch, no stash nem no git status. O Faundr guarda os 50 mais recentes.
Comandos internos
Estes comandos existem, mas são chamados pelo próprio plugin, não por você. Estão aqui para você reconhecê-los se aparecerem em algum registro.
| Comando | Quem chama |
|---|---|
faundr hook, faundr gate, faundr guard, faundr subagent-start | As automações do plugin dentro do agente. Veja O que o Faundr faz sozinho. |
faundr statusline, faundr status-refresh | A barra de status. |
faundr checkpoints-sync, faundr usage-sync, faundr background | As tarefas em segundo plano. |
faundr *-context, *-finding, *-review-done, *-save, design-measure-*, showcase-* | Os comandos do agente (/faundr:…), para montar o contexto e registrar o que o agente encontrou. |
faundr skill-report "<skill>" --areas <áreas> (--file <achados.json> | --none) | O agente, no fim de uma resposta em que rodou uma skill conectada: manda o que ela achou e corrigiu, que vira S-n, Q-n, T-n ou E-n com "via /nome". As chaves vão mascaradas. |