Comandos do cfour

Esta página é gerada a partir da própria declaração de comandos da ferramenta. Ela não pode divergir do que o cfour faz.

O mesmo conteúdo está disponível offline:

cfour help                  # a árvore inteira
cfour help element add      # um comando só
cfour help --output json    # em JSON, para um agente

As convenções que valem em vários comandos

--dry-run, --json, --no-input, --modelagem e --file aparecem em quase todo comando que escreve, e fazem sempre a mesma coisa. O que cada uma significa está em Visão geral do cfour.

cfour init [id]

cria a menor modelagem que desenha algo

Argumento	Obrigatório	O que é
id	não	id da modelagem (padrao: arquitetura)

Opção	Repetível	O que faz
--id <id>	não	id da modelagem
--nome <nome>	não	nome legivel da modelagem
--force	não	escreve mesmo onde ja ha um registro governando

cfour check

valida uma modelagem

Opção	Repetível	O que faz
--modelagem <id>	não	qual modelagem validar
--all	não	valida todas as modelagens do registro, e confere os espelhos
--root <dir>	não	valida uma arvore avulsa, ignorando o registro
--json	não	saida em JSON
--inventory	não	inclui o inventario do modelo (implica --json)

cfour serve

viewer local; arrastar salva em .layout/

Opção	Repetível	O que faz
--modelagem <id>	não	qual modelagem abre primeiro
--port <porta>	não	porta (padrao: 5173)
--host <host>	não	escuta fora do loopback (padrao: 127.0.0.1)

cfour login [key]

guarda uma chave e vincula a este repo

Argumento	Obrigatório	O que é
key	não	a chave, se preferir sem --key

Opção	Repetível	O que faz
--key <chave>	não	a chave: c4_<id>_<segredo>
--profile <nome>	não	guarda sob outro nome que nao o destino

cfour logout [perfil]

esquece uma chave, ou todas

Argumento	Obrigatório	O que é
perfil	não	qual perfil esquecer

Opção	Repetível	O que faz
--profile <nome>	não	qual perfil esquecer
--all	não	esquece todas

cfour keys

as chaves guardadas, e qual vale aqui

Opção	Repetível	O que faz
--json	não	saida em JSON

cfour use [perfil]

troca a chave deste repo, ou o default

Argumento	Obrigatório	O que é
perfil	não	o perfil a usar

Opção	Repetível	O que faz
--default	não	torna este o perfil default da maquina

cfour push

publica as modelagens status: active

Opção	Repetível	O que faz
--ref <nome>	não	a ref a carimbar (padrao: a do git)
--all	não	inclui as que nao estao com status: active
--dry-run	não	ensaia: diz o destino e nao envia nada
--sha <sha>	não	carimba outro commit
--profile <nome>	não	usa outra chave
--no-input	não	nunca pergunta, mesmo num terminal

cfour push --dry-run
cfour push --ref main
cfour push --all --profile acme

cfour status

o que esta publicado

Opção	Repetível	O que faz
--json	não	saida em JSON
--profile <nome>	não	usa outra chave

cfour element

as caixas: cria, consulta, altera, remove

Também: el

cfour element add <id>

cria uma caixa e a coloca na arvore de contencao

Argumento	Obrigatório	O que é
id	sim	id local, ou <projeto>/<id>

Opção	Repetível	O que faz
--name <nome>	não	o nome legivel (padrao: o proprio id)
--shape <forma>	não	a forma da caixa; `cfour config show` lista as que valem aqui
--parent <ref>	não	a caixa que contem esta; e o que decide o nivel C4
--technology <t>	não	a tecnologia, como aparece na caixa
--description <d>	não	uma frase sobre o que ela faz
--tag <tag>	sim	uma etiqueta; repetivel
--meta <chave=valor>	sim	um metadado; repetivel
--bind <modelagem:ref>	não	espelho de um elemento de outra modelagem
--projeto <id>	não	em qual projeto, quando o id nao diz
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour element add loja --shape system --name "Loja Online"
cfour element add loja-api --parent loja --shape api --technology ".NET 8"
cfour element add pedido-service --parent loja-api --shape component --tag core
cfour element add cache --parent loja --dry-run

cfour element list

lista as caixas, com filtros

Também: ls

Opção	Repetível	O que faz
--modelagem <id>	não	em qual modelagem olhar
--projeto <id>	não	so as de um projeto
--level <nivel>	não	context, container, component ou code
--shape <forma>	não	so as de uma forma
--tag <tag>	não	so as que tem esta etiqueta
--json	não	saida em JSON

cfour element show <ref>

tudo sobre uma caixa, e quem aponta para ela

Também: get

Argumento	Obrigatório	O que é
ref	sim	id local ou <projeto>/<id>

Opção	Repetível	O que faz
--modelagem <id>	não	em qual modelagem olhar
--json	não	saida em JSON

cfour element set <ref>

altera campos de uma caixa que ja existe

Argumento	Obrigatório	O que é
ref	sim	id local ou <projeto>/<id>

Opção	Repetível	O que faz
--name <nome>	não	o nome legivel
--shape <forma>	não	a forma
--parent <ref>	não	move na arvore de contencao; e o que muda o nivel C4
--technology <t>	não	a tecnologia
--description <d>	não	uma frase sobre o que ela faz
--bind <modelagem:ref>	não	espelho de um elemento de outra modelagem
--tag <tag>	sim	acrescenta uma etiqueta; repetivel
--tag-rm <tag>	sim	tira uma etiqueta; repetivel
--meta <chave=valor>	sim	define um metadado; repetivel
--meta-rm <chave>	sim	tira um metadado; repetivel
--clear <campo>	sim	apaga um campo; repetivel
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour element set loja-api --technology ".NET 9"
cfour element set loja/loja-web --name "Vitrine"
cfour element set pedido-service --parent loja-api      # reclassifica o nivel C4
cfour element set loja-api --tag pci --tag-rm legado
cfour element set loja-api --meta owner=squad-checkout --meta-rm layer
cfour element set loja-api --clear technology

cfour element rm <ref>

remove uma caixa, se ninguem depender dela

Também: remove

Argumento	Obrigatório	O que é
ref	sim	id local ou <projeto>/<id>

Opção	Repetível	O que faz
--cascade	não	nao recusa por causa de quem aponta para ela
--yes	não	segue sem confirmar; so faz sentido junto de --cascade
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour element rm loja/loja-legacy --dry-run
cfour element rm loja/loja-legacy

cfour element mv <ref> <novo-id>

renomeia uma caixa, e conserta quem apontava para ela

Também: rename

Argumento	Obrigatório	O que é
ref	sim	id local ou <projeto>/<id>
novo-id	sim	o id novo, local

Opção	Repetível	O que faz
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour element mv loja-api api-de-pedidos --dry-run
cfour element mv loja/loja-legacy carrinho-antigo

cfour relation

as setas entre as caixas

Também: rel

cfour relation add <origem> <destino>

liga duas caixas

Argumento	Obrigatório	O que é
origem	sim	de onde a seta sai
destino	sim	onde a seta chega

Opção	Repetível	O que faz
--kind <tipo>	não	o tipo da seta (padrao: sync); `cfour config show` lista os que valem aqui
--label <texto>	não	o que trafega, em poucas palavras
--description <d>	não	a forma longa, que aparece ao passar o mouse
--tag <tag>	sim	uma etiqueta; repetivel
--meta <chave=valor>	sim	um metadado; repetivel
--route <r>	não	straight, orthogonal ou bezier; sem isto vale o padrao do diagrama
--bidirectional	não	poe ponta tambem na origem
--inline	não	escreve dentro do documento da origem, com o from implicito
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour relation add loja-web loja-api --kind sync --label Chama
cfour relation add pedido-service loja-db --inline
cfour relation add loja-api estoque/estoque-api --kind async --dry-run

cfour relation list

lista as setas, com filtros

Também: ls

Opção	Repetível	O que faz
--modelagem <id>	não	em qual modelagem olhar
--from <ref>	não	so as que saem daqui
--to <ref>	não	so as que chegam aqui
--kind <tipo>	não	so as deste tipo
--json	não	saida em JSON

cfour relation show <origem> <destino>

tudo sobre uma seta

Também: get

Argumento	Obrigatório	O que é
origem	sim	de onde a seta sai
destino	sim	onde a seta chega

Opção	Repetível	O que faz
--kind <tipo>	não	quando ha mais de uma seta entre as duas caixas
--modelagem <id>	não	em qual modelagem olhar
--json	não	saida em JSON

cfour relation set <origem> <destino>

altera uma seta que ja existe

Argumento	Obrigatório	O que é
origem	sim	de onde a seta sai
destino	sim	onde a seta chega

Opção	Repetível	O que faz
--kind <tipo>	não	quando ha mais de uma seta entre as duas caixas
--label <texto>	não	o que trafega, em poucas palavras
--description <d>	não	a forma longa, que aparece ao passar o mouse
--route <r>	não	straight, orthogonal ou bezier
--bidirectional	não	poe ponta tambem na origem
--tag <tag>	sim	acrescenta uma etiqueta; repetivel
--tag-rm <tag>	sim	tira uma etiqueta; repetivel
--meta <chave=valor>	sim	define um metadado; repetivel
--meta-rm <chave>	sim	tira um metadado; repetivel
--clear <campo>	sim	apaga um campo; repetivel
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour relation set loja-web loja-api --label "Chama a API"
cfour relation set loja-web loja-api --bidirectional --tag critico
cfour relation set loja-api loja-db --kind sync --clear description

cfour relation mv <origem> <destino> <novo-kind>

troca o tipo de uma seta

Argumento	Obrigatório	O que é
origem	sim	de onde a seta sai
destino	sim	onde a seta chega
novo-kind	sim	o tipo novo

Opção	Repetível	O que faz
--kind <tipo>	não	o tipo ATUAL, quando ha mais de uma seta entre as duas caixas
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour relation mv loja-api estoque/estoque-api async
cfour relation mv loja-web loja-api event --kind sync --dry-run

cfour relation rm <origem> <destino>

desfaz uma seta

Também: remove

Argumento	Obrigatório	O que é
origem	sim	de onde a seta sai
destino	sim	onde a seta chega

Opção	Repetível	O que faz
--kind <tipo>	não	quando ha mais de uma seta entre as duas caixas
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour relation rm loja-web loja-api
cfour relation rm loja-web loja-db --kind async --dry-run

cfour note

os recados: presos numa caixa, ou soltos num diagrama

cfour note add <alvo> <texto>

escreve um recado

Argumento	Obrigatório	O que é
alvo	sim	a caixa OU o diagrama que recebe a nota
texto	sim	o que a nota diz

Opção	Repetível	O que faz
--kind <tipo>	não	o tipo da nota (padrao: info); `cfour config show` lista os que valem aqui
--target <ref>	não	a caixa, quando o mesmo id nomeia uma caixa e um diagrama
--scope <diagrama>	não	o diagrama, para restringir uma nota de caixa a um desenho so
--meta <chave=valor>	sim	um metadado; repetivel
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour note add loja-api "Ponto unico de falha" --kind risk
cfour note add loja-db "Vale separar a replica?" --kind question --scope containers
cfour note add containers "Congelado para a revisao de 2026-Q1"

cfour note list

lista as notas

Também: ls

Opção	Repetível	O que faz
--modelagem <id>	não	em qual modelagem olhar
--target <ref>	não	so as de uma caixa
--scope <diagrama>	não	so as de um diagrama
--json	não	saida em JSON

cfour note set <alvo>

altera um recado que ja existe

Argumento	Obrigatório	O que é
alvo	sim	a caixa ou o diagrama que tem a nota

Opção	Repetível	O que faz
--text <texto>	não	o texto novo
--kind <tipo>	não	o tipo novo
--scope <diagrama>	não	restringe a nota a um diagrama
--meta <chave=valor>	sim	define um metadado; repetivel
--meta-rm <chave>	sim	tira um metadado; repetivel
--clear <campo>	sim	apaga um campo; repetivel
--match <trecho>	não	quando o alvo tem mais de uma nota
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour note set loja-api --text "Ponto unico de falha do fechamento"
cfour note set loja-db --match replica --kind decision
cfour note set containers --clear scope

cfour note rm <alvo>

tira um recado

Também: remove

Argumento	Obrigatório	O que é
alvo	sim	a caixa ou o diagrama que tem a nota

Opção	Repetível	O que faz
--match <trecho>	não	quando o alvo tem mais de uma nota
--kind <tipo>	não	so as deste tipo
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour note rm loja-legacy
cfour note rm loja-db --match "replica"
cfour note rm contexto --kind info

cfour diagram

as visoes: o que cada desenho mostra

Também: dia

cfour diagram add <id>

cria uma visao

Argumento	Obrigatório	O que é
id	sim	id local, ou <projeto>/<id>

Opção	Repetível	O que faz
--title <titulo>	não	o titulo que aparece no desenho
--scope <ref>	não	a caixa que este diagrama detalha; da a fronteira e o nome
--level <nivel>	não	context, container, component ou code
--order <n>	não	a posicao na lateral
--include <seletor>	sim	uma caixa ou um criterio; repetivel
--exclude <seletor>	sim	tira quem o seletor pega; repetivel
--where <predicado>	sim	filtra o que os seletores trouxeram; repetivel
--neighbors <n>	não	puxa quem esta a N saltos como contexto mudo
--relations <modo>	não	auto ou none
--group-by <chave>	não	meta.<chave> ou level: uma banda por valor
--subject <ref>	não	a caixa em foco
--tag <tag>	sim	uma etiqueta; repetivel
--meta <chave=valor>	sim	um metadado; repetivel
--projeto <id>	não	em qual projeto, quando o id nao diz
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour diagram add containers --scope loja --level container --relations auto
cfour diagram add contexto --level context --include level:context
cfour diagram add integracoes --include tag:externo --include children:loja
cfour diagram add componentes --scope loja-api --group-by meta.domain

cfour diagram list

lista as visoes

Também: ls

Opção	Repetível	O que faz
--modelagem <id>	não	em qual modelagem olhar
--projeto <id>	não	so as de um projeto
--json	não	saida em JSON

cfour diagram show <ref>

tudo sobre uma visao

Também: get

Argumento	Obrigatório	O que é
ref	sim	id local ou <projeto>/<id>

Opção	Repetível	O que faz
--resolved	não	o que o desenho MOSTRA: caixas, setas, e por que cada uma entrou
--modelagem <id>	não	em qual modelagem olhar
--json	não	saida em JSON

cfour diagram show contexto
cfour diagram show contexto --resolved
cfour diagram show loja/containers --resolved --json

cfour diagram set <ref>

altera um diagrama que ja existe

Argumento	Obrigatório	O que é
ref	sim	id local ou <projeto>/<id>

Opção	Repetível	O que faz
--title <titulo>	não	o titulo exibido
--scope <ref>	não	a caixa que o diagrama abre por dentro
--level <nivel>	não	context, container, component ou code
--order <n>	não	ordem na arvore (padrao: 500)
--include <seletor>	sim	acrescenta um seletor ao recorte; repetivel
--include-rm <seletor>	sim	tira um seletor do recorte; repetivel
--exclude <seletor>	sim	acrescenta um seletor a exclusao; repetivel
--exclude-rm <seletor>	sim	tira um seletor da exclusao; repetivel
--where <predicado>	sim	substitui o filtro do diagrama; repetivel
--neighbors <n>	não	quantos saltos de vizinhos trazer
--relations <modo>	não	auto ou none
--group-by <chave>	não	bandas automaticas: meta.<chave>, level, shape ou project
--subject <ref>	não	destaca uma caixa
--subject-rm <ref>	sim	tira o destaque de uma caixa; repetivel
--tag <tag>	sim	acrescenta uma etiqueta; repetivel
--tag-rm <tag>	sim	tira uma etiqueta; repetivel
--meta <chave=valor>	sim	define um metadado; repetivel
--meta-rm <chave>	sim	tira um metadado; repetivel
--clear <campo>	sim	apaga um campo; repetivel
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour diagram set containers --title "Loja Online — Containers"
cfour diagram set contexto --include estoque/estoque --neighbors 1
cfour diagram set contexto --include level:context --include-rm loja
cfour diagram set componentes --group-by meta.domain
cfour diagram set contexto --clear subject

cfour diagram mv <ref> <novo-id>

renomeia um diagrama, e move o layout junto

Também: rename

Argumento	Obrigatório	O que é
ref	sim	id local ou <projeto>/<id>
novo-id	sim	o id novo, dentro do mesmo projeto

Opção	Repetível	O que faz
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour diagram mv containers visao-de-containers --dry-run
cfour diagram mv loja/contexto panorama

cfour diagram rm <ref>

apaga uma visao, e o arquivo dela

Também: remove

Argumento	Obrigatório	O que é
ref	sim	id local ou <projeto>/<id>

Opção	Repetível	O que faz
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour diagram rm loja/rascunho --dry-run
cfour diagram rm rascunho

cfour group

as bandas: agrupa caixas dentro de UM diagrama

cfour group add <diagrama> <id>

cria uma banda no diagrama

Argumento	Obrigatório	O que é
diagrama	sim	id local ou <projeto>/<id>
id	sim	o id da banda, unico no diagrama

Opção	Repetível	O que faz
--name <nome>	não	o rotulo da banda (padrao: o proprio id)
--orientation <o>	não	row para a banda ler como uma linha; sem isto, empilha
--parent <banda>	não	aninha esta banda dentro de outra
--include <seletor>	sim	poe quem o seletor pega nesta banda; repetivel
--include-rm <seletor>	sim	tira um seletor desta banda; repetivel
--match-tag <tag>	sim	entra quem tem esta etiqueta; repetivel
--match-meta <chave=valor>	sim	entra quem tem este metadado; repetivel
--match-level <nivel>	sim	entra quem e deste nivel; repetivel
--match-shape <forma>	sim	entra quem tem esta forma; repetivel
--match-project <id>	sim	entra quem e deste projeto; repetivel
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour group add containers dados --name Dados --match-shape database
cfour group add containers experiencia --name "Experiência" --orientation row --include loja-web
cfour group add containers replicas --parent dados --match-tag replica

cfour group list <diagrama>

as bandas de um diagrama, com o aninhamento

Também: ls

Argumento	Obrigatório	O que é
diagrama	sim	id local ou <projeto>/<id>

Opção	Repetível	O que faz
--modelagem <id>	não	em qual modelagem olhar
--json	não	saida em JSON

cfour group set <diagrama> <id>

altera uma banda que ja existe

Argumento	Obrigatório	O que é
diagrama	sim	id local ou <projeto>/<id>
id	sim	o id da banda

Opção	Repetível	O que faz
--name <nome>	não	o rotulo da banda
--orientation <o>	não	row ou column
--clear <campo>	sim	apaga um campo; repetivel
--include <seletor>	sim	poe quem o seletor pega nesta banda; repetivel
--include-rm <seletor>	sim	tira um seletor desta banda; repetivel
--match-tag <tag>	sim	entra quem tem esta etiqueta; repetivel
--match-meta <chave=valor>	sim	entra quem tem este metadado; repetivel
--match-level <nivel>	sim	entra quem e deste nivel; repetivel
--match-shape <forma>	sim	entra quem tem esta forma; repetivel
--match-project <id>	sim	entra quem e deste projeto; repetivel
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour group set containers dados --name "Persistência"
cfour group set containers experiencia --include-rm loja-web
cfour group set containers dados --clear match

cfour group rm <diagrama> <id>

tira uma banda do diagrama

Também: remove

Argumento	Obrigatório	O que é
diagrama	sim	id local ou <projeto>/<id>
id	sim	o id da banda

Opção	Repetível	O que faz
--cascade	não	leva junto as bandas aninhadas nela
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour group rm containers dados
cfour group rm containers dominio --cascade

cfour step

os passos de um fluxo, na ordem em que acontecem

cfour step add <fluxo> <destino>

acrescenta um passo

Argumento	Obrigatório	O que é
fluxo	sim	id local ou <projeto>/<id>
destino	sim	quem recebe a mensagem

Opção	Repetível	O que faz
--from <ref>	não	quem envia; sem isto, herda o destino do passo anterior
--label <texto>	não	o que aparece ao lado da linha
--kind <tipo>	não	o tipo da seta; sem isto, o da seta declarada
--reply <texto>	não	uma resposta curta, tracejada, na linha seguinte
--after <id>	não	entra logo depois deste passo; sem isto, no fim
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour step add checkout loja-api --label "Fecha pedido"
cfour step add checkout estoque/estoque-api --from loja-api --label "Reserva"
cfour step add checkout pagamento-client --after cobra

cfour step set <fluxo>

altera um passo

Argumento	Obrigatório	O que é
fluxo	sim	id local ou <projeto>/<id>

Opção	Repetível	O que faz
--from <ref>	não	quem envia
--to <ref>	não	quem recebe
--label <texto>	não	o que aparece ao lado da linha
--kind <tipo>	não	o tipo da seta
--reply <texto>	não	a resposta curta
--description <d>	não	o texto que aparece ao passar o mouse
--clear <campo>	sim	apaga um campo; repetivel
--n <numero>	não	qual passo, pelo numero que `cfour flow show` mostra
--id <id>	não	qual passo, pelo id — quando ele tem um
--path <id>	não	num caminho alternativo; sem isto, no principal
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour step set checkout --n 2 --label "Fecha o pedido"
cfour step set checkout --n 4 --id cobra          # nomeia o passo 4
cfour step set checkout --id cobra --reply "Autorizado"

cfour step mv <fluxo>

reordena um passo

Argumento	Obrigatório	O que é
fluxo	sim	id local ou <projeto>/<id>

Opção	Repetível	O que faz
--after <id|numero>	não	passa a vir logo depois deste
--first	não	passa a ser o primeiro
--n <numero>	não	qual passo, pelo numero que `cfour flow show` mostra
--id <id>	não	qual passo, pelo id — quando ele tem um
--path <id>	não	num caminho alternativo; sem isto, no principal
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour step mv checkout --n 4 --after 2
cfour step mv checkout --id reserva --first

cfour step rm <fluxo>

tira um passo

Também: remove

Argumento	Obrigatório	O que é
fluxo	sim	id local ou <projeto>/<id>

Opção	Repetível	O que faz
--n <numero>	não	qual passo, pelo numero que `cfour flow show` mostra
--id <id>	não	qual passo, pelo id — quando ele tem um
--path <id>	não	num caminho alternativo; sem isto, no principal
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour step rm checkout --n 3
cfour step rm checkout --path recusado --n 1

cfour path

os desvios de um fluxo, com desfecho proprio

cfour path add <fluxo> <id> <destino>

acrescenta um caminho alternativo, com o primeiro passo dele

Argumento	Obrigatório	O que é
fluxo	sim	id local ou <projeto>/<id>
id	sim	o id do caminho, unico no fluxo
destino	sim	quem recebe a primeira mensagem do desvio

Opção	Repetível	O que faz
--name <nome>	não	o nome no seletor (padrao: o proprio id)
--outcome <desfecho>	não	success, failure ou alternate; `cfour config show` lista
--from <passo>	não	o id do passo de onde ele desvia, inclusive
--label <texto>	não	o rotulo do primeiro passo
--kind <tipo>	não	o tipo da seta do primeiro passo
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour path add checkout recusado pagamento-client --name "Pagamento recusado" \
cfour path add checkout sem-estoque loja-web --outcome alternate

cfour path list <fluxo>

os caminhos de um fluxo, com o principal

Também: ls

Argumento	Obrigatório	O que é
fluxo	sim	id local ou <projeto>/<id>

Opção	Repetível	O que faz
--modelagem <id>	não	em qual modelagem olhar
--json	não	saida em JSON

cfour path set <fluxo> <id>

altera um caminho alternativo

Argumento	Obrigatório	O que é
fluxo	sim	id local ou <projeto>/<id>
id	sim	o id do caminho

Opção	Repetível	O que faz
--name <nome>	não	o nome no seletor
--outcome <desfecho>	não	success, failure ou alternate
--from <passo>	não	o id do passo de onde ele desvia
--clear <campo>	sim	apaga um campo; repetivel
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour path set checkout recusado --name "Recusa do emissor"
cfour path set checkout recusado --clear from

cfour path rm <fluxo> <id>

tira um caminho alternativo

Também: remove

Argumento	Obrigatório	O que é
fluxo	sim	id local ou <projeto>/<id>
id	sim	o id do caminho

Opção	Repetível	O que faz
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour path rm checkout recusado

cfour federacao

as leituras conjuntas de duas ou mais modelagens

cfour federacao add <id>

declara uma leitura conjunta

Argumento	Obrigatório	O que é
id	sim	o apelido da leitura

Opção	Repetível	O que faz
--modelagem <id>	sim	um membro; repita para os demais
--name <nome>	não	o rotulo exibido
--curador <id>	não	de quem vale a configuracao quando os membros discordam
--dry-run	não	mostra o que mudaria e nao escreve nada

cfour federacao add plataforma --modelagem loja --modelagem logistica
cfour federacao add par --modelagem a --modelagem b --curador a --dry-run

cfour federacao list

as leituras conjuntas, e se os dois lados concordam

Também: ls

Opção	Repetível	O que faz
--json	não	saida em JSON

cfour federacao rm <id>

desfaz uma leitura conjunta, nos dois lados

Também: remove

Argumento	Obrigatório	O que é
id	sim	o apelido da leitura

Opção	Repetível	O que faz
--dry-run	não	mostra o que mudaria e nao escreve nada

cfour federacao rm par --dry-run
cfour federacao rm plataforma

cfour flow

os casos de uso, contados como sequencia

cfour flow add <id> <origem> <destino>

cria um fluxo, ja com o primeiro passo

Argumento	Obrigatório	O que é
id	sim	id local, ou <projeto>/<id>
origem	sim	quem inicia o primeiro passo
destino	sim	quem recebe o primeiro passo

Opção	Repetível	O que faz
--title <titulo>	não	o titulo do caso de uso
--scope <ref>	não	onde ele acontece; da a trilha e o lugar na arvore
--level <nivel>	não	o nivel em que ele abre
--order <n>	não	a posicao na lateral
--main <nome>	não	o nome do caminho feliz (padrao: Caminho feliz)
--outcome <desfecho>	não	o desfecho (padrao: success); `cfour config show` lista os que valem aqui
--participant <ref>	sim	fixa a ordem das lifelines; repetivel
--label <texto>	não	o rotulo do primeiro passo
--kind <tipo>	não	o tipo do primeiro passo
--tag <tag>	sim	uma etiqueta; repetivel
--projeto <id>	não	em qual projeto, quando o id nao diz
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour flow add checkout cliente loja-web --title "Fechar pedido" --scope loja
cfour flow add reserva loja-api estoque-api --label "Reserva itens"

cfour flow step <fluxo> <destino>

acrescenta um passo a sequencia

Argumento	Obrigatório	O que é
fluxo	sim	id local ou <projeto>/<id>
destino	sim	quem recebe a mensagem

Opção	Repetível	O que faz
--from <ref>	não	quem envia; omitido, herda o destino do passo anterior
--label <texto>	não	o que a mensagem diz
--kind <tipo>	não	o tipo da seta
--reply <texto>	não	a resposta, tracejada na propria linha
--after <id>	não	entra depois deste passo; sem isto, entra no fim
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour flow step checkout loja-api --label "Fecha pedido"
cfour flow step checkout loja-db --from pedido-service --label Persiste
cfour flow step checkout gateway --after cobra --label Autoriza

cfour flow set <ref>

altera um fluxo que ja existe

Argumento	Obrigatório	O que é
ref	sim	id local ou <projeto>/<id>

Opção	Repetível	O que faz
--title <titulo>	não	o titulo exibido
--scope <ref>	não	onde o caso de uso acontece
--level <nivel>	não	em qual altura o fluxo abre
--order <n>	não	ordem na arvore (padrao: 500)
--main <nome>	não	o nome do caminho principal
--outcome <desfecho>	não	o desfecho do caminho principal
--participant <ref>	sim	acrescenta uma coluna; repetivel
--participant-rm <ref>	sim	tira uma coluna; repetivel
--tag <tag>	sim	acrescenta uma etiqueta; repetivel
--tag-rm <tag>	sim	tira uma etiqueta; repetivel
--meta <chave=valor>	sim	define um metadado; repetivel
--meta-rm <chave>	sim	tira um metadado; repetivel
--clear <campo>	sim	apaga um campo; repetivel
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour flow set checkout --title "Fechar pedido"
cfour flow set checkout --main "Pedido aprovado" --outcome success
cfour flow set checkout --participant shared/cliente --participant loja-web

cfour flow mv <ref> <novo-id>

renomeia um fluxo

Também: rename

Argumento	Obrigatório	O que é
ref	sim	id local ou <projeto>/<id>
novo-id	sim	o id novo, dentro do mesmo projeto

Opção	Repetível	O que faz
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour flow mv checkout fechar-pedido --dry-run

cfour flow rm <ref>

remove um fluxo inteiro

Também: remove

Argumento	Obrigatório	O que é
ref	sim	id local ou <projeto>/<id>

Opção	Repetível	O que faz
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour flow rm conciliacao --dry-run
cfour flow rm loja/checkout

cfour flow list

lista os fluxos, com passos e desfechos

Também: ls

Opção	Repetível	O que faz
--modelagem <id>	não	em qual modelagem olhar
--projeto <id>	não	so os de um projeto
--json	não	saida em JSON

cfour flow show <ref>

a sequencia inteira, passo a passo

Também: get

Argumento	Obrigatório	O que é
ref	sim	id local ou <projeto>/<id>

Opção	Repetível	O que faz
--modelagem <id>	não	em qual modelagem olhar
--json	não	saida em JSON

cfour project

as pastas sob model/ que agrupam tudo

Também: proj

cfour project add <id>

cria um projeto

Argumento	Obrigatório	O que é
id	sim	o id, que e tambem o nome da pasta

Opção	Repetível	O que faz
--name <nome>	não	o nome legivel
--order <n>	não	a posicao na lateral
--tag <tag>	sim	uma etiqueta; repetivel
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour project add loja --name "Loja Online" --order 10

cfour project set <id>

altera o nome, a ordem e as etiquetas de um projeto

Argumento	Obrigatório	O que é
id	sim	o id do projeto, que e o nome da pasta

Opção	Repetível	O que faz
--name <nome>	não	o nome exibido na arvore
--order <n>	não	ordem entre os projetos (padrao: 500)
--tag <tag>	sim	acrescenta uma etiqueta; repetivel
--tag-rm <tag>	sim	tira uma etiqueta; repetivel
--meta <chave=valor>	sim	define um metadado; repetivel
--meta-rm <chave>	sim	tira um metadado; repetivel
--clear <campo>	sim	apaga um campo; repetivel
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour project set loja --name "Loja Online" --order 10
cfour project set loja --meta owner=tribo-vendas

cfour project rm <id>

remove um projeto, e a pasta dele

Também: remove

Argumento	Obrigatório	O que é
id	sim	o id do projeto

Opção	Repetível	O que faz
--cascade	não	apaga a pasta mesmo com conteudo dentro
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour project rm rascunho --dry-run
cfour project rm rascunho --cascade

cfour project list

lista os projetos, com o que ha em cada um

Também: ls

Opção	Repetível	O que faz
--modelagem <id>	não	em qual modelagem olhar
--json	não	saida em JSON

cfour find <termo>

procura em id, nome, descricao, tag, meta e texto de nota

Argumento	Obrigatório	O que é
termo	sim	o que procurar; casa em qualquer parte, sem acento e sem caixa

Opção	Repetível	O que faz
--modelagem <id>	não	em qual modelagem olhar
--tipo <tipo>	não	element, relation, note, diagram, flow ou project
--json	não	saida em JSON

cfour find checkout
cfour find PostgreSQL --tipo element
cfour find "ponto unico de falha" --tipo note
cfour find "pedido" --json

cfour refs <ref>

onde uma caixa e usada

Argumento	Obrigatório	O que é
ref	sim	id local ou <projeto>/<id>

Opção	Repetível	O que faz
--modelagem <id>	não	em qual modelagem olhar
--json	não	saida em JSON

cfour refs loja-api

cfour config

formas, tipos de seta, de nota e de desfecho

cfour config rm <registro> <chave>

tira uma chave de um registro do workspace.yaml

Também: remove

Argumento	Obrigatório	O que é
registro	sim	shapes, relationKinds, noteKinds, flowOutcomes, metadata ou palette
chave	sim	a chave a remover

Opção	Repetível	O que faz
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour config rm noteKinds decision
cfour config rm shapes lambda --dry-run

cfour config title <texto>

o titulo desta modelagem, no alto da barra lateral

Argumento	Obrigatório	O que é
texto	sim	o titulo

Opção	Repetível	O que faz
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour config title "Arquitetura da Loja"

cfour config show

a configuracao efetiva: os defaults com o workspace.yaml por cima

Opção	Repetível	O que faz
--modelagem <id>	não	em qual modelagem olhar
--json	não	saida em JSON

cfour config set <registro> <chave>

acrescenta ou altera uma chave de um registro aberto

Argumento	Obrigatório	O que é
registro	sim	shapes, relationKinds, noteKinds, flowOutcomes, metadata ou palette
chave	sim	o nome novo, que o YAML passa a aceitar

Opção	Repetível	O que faz
--label <texto>	não	o rotulo legivel
--color <cor>	não	a cor, em hex
--dash <padrao>	não	o tracejado de uma seta (stroke-dasharray)
--char <c>	não	o caractere do cracha de uma nota
--stereotype <texto>	não	o que aparece entre guilemetes na caixa
--palette <chave>	não	qual entrada da paleta a forma usa
--primitive <nome>	não	o desenho base da forma
--modelagem <id>	não	em qual modelagem mexer
--dry-run	não	mostra o patch e nao escreve nada
--file <caminho>	não	força o arquivo de destino, dentro do projeto
--json	não	saida em JSON: o que mudou, ou o erro com codigo estavel
--no-input	não	nunca pergunta, mesmo num terminal

cfour config set relationKinds webhook --label Webhook --dash "4 2"
cfour config set noteKinds decisao --label Decisao --char D
cfour config set shapes lambda --primitive container --stereotype Function

cfour modelagem

as realidades registradas no cfour.yaml

Também: modelagens

cfour modelagem list

lista as modelagens do registro

Também: ls

Opção	Repetível	O que faz
--json	não	saida em JSON

cfour modelagem add <id>

registra uma modelagem que ja existe no disco

Argumento	Obrigatório	O que é
id	sim	o id, unico no registro

Opção	Repetível	O que faz
--path <dir>	não	a pasta da modelagem, que tem um model/ dentro
--name <nome>	não	o nome legivel
--ativa	não	passa a ser a que abre quando ninguem diz qual
--dry-run	não	mostra o que mudaria e nao escreve nada

cfour modelagem add logistica --path ./logistica --name "Logistica"
cfour modelagem add legado --path ~/Git/legado-arquitetura

cfour modelagem set <id>

altera uma modelagem: nome, caminho, descricao e status

Argumento	Obrigatório	O que é
id	sim	o id no registro

Opção	Repetível	O que faz
--name <nome>	não	o nome legivel
--path <dir>	não	a pasta da modelagem
--description <d>	não	a prosa que diz para que ela existe
--status <s>	não	active, reference ou archived
--federacao <id>	não	a leitura conjunta de que ela participa
--clear <campo>	sim	apaga description ou federacao; repetivel
--dry-run	não	mostra o que mudaria e nao escreve nada

cfour modelagem set exemplos --status reference
cfour modelagem set exemplos --name "Exemplos" --description "So para ensinar"
cfour modelagem set legado --path ./arquivo/legado --dry-run

cfour modelagem use <id>

troca a modelagem que abre quando ninguem diz qual

Argumento	Obrigatório	O que é
id	sim	o id no registro

Opção	Repetível	O que faz
--dry-run	não	mostra o que mudaria e nao escreve nada

cfour modelagem use logistica

cfour modelagem show <id>

tudo sobre uma modelagem, dos dois arquivos de uma vez

Também: get

Argumento	Obrigatório	O que é
id	sim	o id no registro

Opção	Repetível	O que faz
--json	não	saida em JSON

cfour modelagem rm <id>

tira uma modelagem do registro; nunca apaga arquivo

Também: remove

Argumento	Obrigatório	O que é
id	sim	o id no registro

Opção	Repetível	O que faz
--dry-run	não	mostra o que mudaria e nao escreve nada

cfour modelagem rm legado

cfour completion <shell>

o script de autocompletar deste shell

Argumento	Obrigatório	O que é
shell	sim	bash, zsh ou fish

cfour version

a versao deste CLI

cfour help [comando]

a ajuda de um comando so

Argumento	Obrigatório	O que é
comando	não	de qual comando

Opção	Repetível	O que faz
--output <formato>	não	text (padrao) ou json: a arvore inteira, para um agente