Comandos Herdr TUI

Consulte os grupos abaixo para localizar um comando e seus argumentos. Substitua os valores entre <...> pelos IDs, caminhos ou textos da sua sessão. Os colchetes indicam opções e a barra vertical separa alternativas. Não copie esses marcadores literalmente.

Para direcionar uma consulta, coloque --session NOME ou --machine PERFIL antes do grupo. Sem esses seletores, a CLI usa a sessão local correspondente ao ambiente. A seleção de uma máquina na interface não altera o destino dos comandos executados em outro terminal.

Abertura e opções globais

Abre o cliente e conecta à sessão. As opções globais selecionam a sessão ou a máquina antes do subcomando.

1
herdr
2
herdr --session <name>
3
herdr --remote <target> [--session <name>] [--remote-keybindings local|server] [--handoff]
4
herdr --machine <label-or-id> <command>
5
herdr --default-config
6
herdr --skill
7
herdr --version
8
herdr --help
9
herdr <command> --help

--default-config imprime a configuração padrão e --skill imprime as instruções para agentes. -V e -h equivalem a --version e --help. Não combine --machine com --session ou --remote. O handoff é uma opção experimental, ativada somente com --handoff.

Atualização e canal

Gerencia a atualização da instalação local e o canal usado para baixar versões.

update

Baixa e instala a atualização.

1
herdr update [--handoff]

channel show

Mostra o canal atual.

1
herdr channel show

channel set

Seleciona stable ou preview.

1
herdr channel set <stable|preview>

Status e configuração

Consulta o cliente e o servidor, valida o arquivo de configuração e restaura os atalhos personalizados.

status

Consulta o estado local.

1
herdr status [--json]

status server

Consulta o servidor.

1
herdr status server [--json]

status client

Consulta o cliente.

1
herdr status client [--json]

config check

Valida config.toml.

1
herdr config check

config reset-keys

Faz backup e remove os atalhos personalizados.

1
herdr config reset-keys

Conclusão no shell

Gera o script de conclusão para o shell escolhido. A saída vai para o terminal e pode ser redirecionada para um arquivo.

completion

Gera a conclusão do shell.

1
herdr completion <bash|elvish|fish|powershell|zsh>

completions

Alias de completion.

1
herdr completions <bash|elvish|fish|powershell|zsh>

Máquinas por SSH

Cadastra máquinas e consulta a conexão. Use o ID do perfil ou, quando aceito, um rótulo único.

machine list

Lista os perfis salvos.

1
herdr machine list [--json]

machine add

Prepara a conexão SSH e grava o perfil da máquina no cliente.

1
herdr machine add <ssh-target> [--label TEXT] [--remote-session NAME]

machine rename

Altera o rótulo do perfil.

1
herdr machine rename <profile-id> --label "New name"

machine disable

Desativa a conexão do perfil.

1
herdr machine disable <profile-id>

machine enable

Ativa a conexão do perfil.

1
herdr machine enable <profile-id>

machine remove

Remove o perfil local.

1
herdr machine remove <profile-id>

machine status

Verifica a conexão sem abrir uma autenticação interativa.

1
herdr machine status [<label-or-id>] [--json]

machine reconnect

Autentica e verifica a máquina no terminal.

1
herdr machine reconnect <label-or-id>

Servidor

Controla o servidor e os manifestos que reconhecem agentes. Parar o servidor encerra os processos dos painéis da sessão.

server

Executa o servidor sem interface.

1
herdr server
2
herdr server --allow-unelevated-clients

server stop

Encerra o servidor e os processos dos painéis.

1
herdr server stop

server reload-config

Aplica as opções recarregáveis da configuração.

1
herdr server reload-config

server agent-manifests

Mostra os manifestos ativos de agentes.

1
herdr server agent-manifests [--json]

server update-agent-manifests

Busca e recarrega os manifestos remotos.

1
herdr server update-agent-manifests [--json]

server reload-agent-manifests

Recarrega as alterações locais dos manifestos.

1
herdr server reload-agent-manifests

A opção --allow-unelevated-clients existe no Windows e permite que clientes sem elevação, do mesmo usuário do Windows, controlem um servidor elevado.

API

Consulta o estado da sessão e o schema da API. O snapshot depende de um servidor em execução.

api snapshot

Mostra o estado atual da sessão.

1
herdr api snapshot

api schema

Imprime o schema da API no terminal ou grava o documento em um arquivo.

1
herdr api schema [--json] [--output PATH]

Sessões

Lista, abre, para e exclui sessões nomeadas. Para a sessão padrão, use o nome default.

session list

Lista as sessões.

1
herdr session list [--json]

session attach

Abre o cliente na sessão indicada.

1
herdr session attach <name>

session stop

Encerra a sessão e seus processos.

1
herdr session stop <name> [--json]

session delete

Exclui a sessão nomeada.

1
herdr session delete <name> [--json]

Workspaces

Gerencia os espaços de trabalho. A criação também abre a primeira aba e o painel inicial.

workspace list

Lista os workspaces.

1
herdr workspace list

workspace create

Cria um workspace com aba e painel.

1
herdr workspace create [--cwd PATH] [--label TEXT] [--env KEY=VALUE] [--focus] [--no-focus]

workspace get

Consulta um workspace.

1
herdr workspace get <workspace_id>

workspace focus

Seleciona um workspace.

1
herdr workspace focus <workspace_id>

workspace rename

Renomeia um workspace.

1
herdr workspace rename <workspace_id> <label>

workspace report-metadata

Publica tokens visuais do workspace.

1
herdr workspace report-metadata <workspace_id> --source ID [--token NAME=VALUE] [--clear-token NAME] [--seq N] [--ttl-ms N]

workspace close

Fecha um workspace ou seu grupo.

1
herdr workspace close <workspace_id> [--group]

Worktrees

Cria ou abre um checkout Git separado para trabalhar em outra branch. Fechar um workspace não remove o checkout.

worktree list

Lista os worktrees.

1
herdr worktree list [--workspace ID | --cwd PATH] [--trust-repository]

worktree create

Cria o checkout e abre um workspace.

1
herdr worktree create [--workspace ID | --cwd PATH] [--branch NAME] [--base REF] [--path PATH] [--label TEXT] [--focus] [--no-focus] [--trust-repository]

worktree open

Abre um checkout existente.

1
herdr worktree open [--workspace ID | --cwd PATH] (--path PATH | --branch NAME) [--label TEXT] [--focus] [--no-focus] [--trust-repository]

worktree remove

Remove o checkout Git associado ao workspace.

1
herdr worktree remove --workspace ID [--force] [--trust-repository]

Abas

Gerencia as abas de um workspace. Ao criar uma aba, --cwd define o diretório do novo terminal.

tab list

Lista as abas.

1
herdr tab list [--workspace <workspace_id>]

tab create

Cria uma aba.

1
herdr tab create [--workspace <workspace_id>] [--cwd PATH] [--label TEXT] [--env KEY=VALUE] [--focus] [--no-focus]

tab get

Consulta uma aba.

1
herdr tab get <tab_id>

tab focus

Seleciona uma aba.

1
herdr tab focus <tab_id>

tab rename

Renomeia uma aba.

1
herdr tab rename <tab_id> <label>

tab close

Fecha uma aba.

1
herdr tab close <tab_id>

Painéis

Consulta, reorganiza e controla os terminais. Nos comandos que aceitam --current, o alvo é o painel que executa a CLI.

pane list

Lista os painéis.

1
herdr pane list [--workspace <workspace_id>]

pane current

Identifica o painel atual.

1
herdr pane current [--pane ID|--current]

pane get

Consulta um painel.

1
herdr pane get <pane_id>

pane layout

Mostra a disposição dos painéis.

1
herdr pane layout [--pane ID|--current]

pane process-info

Consulta os processos do painel.

1
herdr pane process-info [--pane ID|--current]

pane neighbor

Localiza o painel vizinho.

1
herdr pane neighbor --direction left|right|up|down [--pane ID|--current]

pane edges

Consulta as bordas do painel.

1
herdr pane edges [--pane ID|--current]

pane focus

Move o foco na direção indicada.

1
herdr pane focus --direction left|right|up|down [--pane ID|--current]

pane resize

Redimensiona o painel.

1
herdr pane resize --direction left|right|up|down [--amount FLOAT] [--pane ID|--current]

pane zoom

Alterna ou define a ampliação.

1
herdr pane zoom [<pane_id>|--pane ID|--current] [--toggle|--on|--off]

pane rename

Define ou limpa o nome.

1
herdr pane rename <pane_id> <label>|--clear

pane input

Configura o clique direito.

1
herdr pane input [<pane_id>|--pane ID|--current] --right-click herdr|pane

pane split

Divide o painel e inicia outro terminal.

1
herdr pane split [<pane_id>|--pane ID|--current] --direction right|down [--ratio FLOAT] [--cwd PATH] [--env KEY=VALUE] [--right-click herdr|pane] [--focus] [--no-focus]

pane swap

Troca a posição de dois painéis.

1
herdr pane swap --direction left|right|up|down [--pane ID|--current]

pane move

Move o painel para outro layout.

1
herdr pane move <pane_id> --tab <tab_id> --split right|down [--target-pane ID] [--ratio FLOAT] [--focus|--no-focus]
2
herdr pane move <pane_id> --new-tab [--workspace ID] [--label TEXT] [--focus|--no-focus]
3
herdr pane move <pane_id> --new-workspace [--label TEXT] [--tab-label TEXT] [--focus|--no-focus]

pane close

Fecha o painel.

1
herdr pane close <pane_id>

pane read

Lê o texto do terminal.

1
herdr pane read <pane_id> [--source visible|recent|recent-unwrapped|detection] [--lines N] [--format text|ansi] [--ansi] [--raw]

pane send-text

Envia texto ao terminal sem a tecla Enter.

1
herdr pane send-text <pane_id> <text>

pane send-keys

Envia teclas ao terminal.

1
herdr pane send-keys <pane_id> <key> [key ...]

pane run

Envia uma linha ao terminal seguida da tecla Enter.

1
herdr pane run <pane_id> <command>

pane wait-output

Espera um texto ou expressão na saída.

1
herdr pane wait-output <pane_id> (--match <text> | --regex <pattern>) [--source visible|recent|recent-unwrapped] [--lines N] [--timeout MS] [--raw]

pane report-agent

Informa o estado do agente por um hook.

1
herdr pane report-agent <pane_id>  --source ID  --agent LABEL  --state idle|working|blocked|unknown  [--message TEXT]  [--seq N]  [--agent-session-id ID]  [--agent-session-path PATH]  [-- RESUME_COMMAND...]

pane report-agent-session

Registra a sessão nativa do agente.

1
herdr pane report-agent-session <pane_id>  --source ID  --agent LABEL  [--seq N]  [--agent-session-id ID]  [--agent-session-path PATH]  [--session-start-source SOURCE]  [-- RESUME_COMMAND...]

pane release-agent

Encerra o controle de estado da fonte.

1
herdr pane release-agent <pane_id>  --source ID  --agent LABEL  [--seq N]

pane report-metadata

Publica rótulos e tokens visuais.

1
herdr pane report-metadata <pane_id>  --source ID  [--agent LABEL]  [--applies-to-source ID]  [--title TEXT|--clear-title]  [--display-agent TEXT|--clear-display-agent]  [--state-label STATUS=TEXT]  [--clear-state-labels]  [--token NAME=VALUE]  [--clear-token NAME]  [--seq N]  [--ttl-ms N]

pane run envia o comando com Enter. Antes de usá-lo, confirme que o painel contém o shell ou o programa que deve receber a entrada. send-text e send-keys permitem controlar esses envios separadamente.

--source visible lê a tela atual. recent lê o histórico recente, recent-unwrapped remove as quebras visuais e detection lê a região usada para reconhecer o agente.

Agentes

O alvo é o nome único de um agente ativo ou o ID do painel que o contém. Os nomes de agentes e comandos permanecem no formato original.

agent list

Lista os agentes detectados.

1
herdr agent list

agent get

Consulta um agente.

1
herdr agent get <target>

agent read

Lê a saída do agente.

1
herdr agent read <target> [--source visible|recent|recent-unwrapped|detection] [--lines N] [--format text|ansi] [--ansi]

agent send-keys

Envia teclas ao agente.

1
herdr agent send-keys <target> <key> [key ...]

agent prompt

Envia uma mensagem ao agente.

1
herdr agent prompt <target> <text> [--wait] [--until STATUS]... [--timeout MS]

agent rename

Define ou limpa o nome do agente.

1
herdr agent rename <target> <name>|--clear

agent focus

Seleciona o painel do agente.

1
herdr agent focus <target>

agent wait

Espera um estado do agente.

1
herdr agent wait <target> [--until STATUS]... [--timeout MS]

agent attach

Conecta ao terminal do agente.

1
herdr agent attach <target> [--takeover]

agent start

Inicia um agente em um painel com shell disponível.

1
herdr agent start <name> --kind KIND --pane ID [--timeout MS] [-- <agent-args...>]

agent explain

Explica a classificação do estado detectado.

1
herdr agent explain <target> [--json|--verbose]
2
herdr agent explain --file PATH --agent LABEL [--json|--verbose]

agent start exige um painel cujo shell esteja disponível. Em prompt --wait e wait, --until pode selecionar idle, done, blocked ou unknown. Sem --timeout, a espera pelo estado pode continuar indefinidamente. Após um timeout, consulte a saída do agente antes de reenviar a mensagem.

Terminais

Conecta diretamente ao terminal ou abre um fluxo de observação e controle. Observe é somente leitura, enquanto control aceita entrada.

terminal attach

Conecta pelo ID do terminal.

1
herdr terminal attach <terminal_id> [--takeover]

terminal session control

Abre um fluxo com controle de entrada.

1
herdr terminal session control <target> [--takeover] [--cols N] [--rows N]

terminal session observe

Abre um fluxo somente de leitura.

1
herdr terminal session observe <target> [--cols N] [--rows N]

terminal title set

Define o título da janela de terminal.

1
herdr terminal title set <title>

terminal title clear

Devolve o título à configuração do Herdr.

1
herdr terminal title clear

Para sair da conexão direta, pressione Ctrl+B e depois Q. --takeover transfere o controle de entrada para a nova conexão.

Notificações

Envia uma notificação usando a configuração de entrega do Herdr.

notification show

Exibe uma notificação.

1
herdr notification show <title> [--body TEXT] [--position top-left|top-right|bottom-left|bottom-right] [--sound none|done|request]

Integrações

Instala ou remove a integração que informa ao Herdr os estados e as sessões nativas dos agentes.

integration install

Instala a integração do agente.

1
herdr integration install <agent>

integration uninstall

Remove a integração do agente.

1
herdr integration uninstall <agent>

integration status

Consulta as integrações instaladas.

1
herdr integration status [--outdated-only]

Agentes aceitos pela integração: pi, omp, claude, codex, copilot, devin, droid, kimi, opencode, kilo, hermes, qodercli, qwen, letta, cursor, mastracode e grok.

Plugins

Instala, atualiza e controla plugins. O estado de instalação e ativação é compartilhado pelas sessões do mesmo usuário.

plugin install

Instala um plugin do GitHub.

1
herdr plugin install <owner>/<repo>[/subdir...] [--ref REF] [--yes]

plugin update

Atualiza os plugins indicados ou todos os gerenciados.

1
herdr plugin update [<plugin_id|owner/repo[/subdir...]>...] [--yes]

plugin list

Lista os plugins instalados.

1
herdr plugin list [--plugin ID] [--json]

plugin uninstall

Remove o registro de uma instalação.

1
herdr plugin uninstall <plugin_id|owner/repo[/subdir...]>

plugin enable

Ativa um plugin.

1
herdr plugin enable <plugin_id>

plugin disable

Desativa um plugin.

1
herdr plugin disable <plugin_id>

plugin link

Vincula um plugin de um diretório local.

1
herdr plugin link <path> [--disabled]

plugin unlink

Remove o vínculo local.

1
herdr plugin unlink <plugin_id>

plugin config-dir

Mostra e prepara o diretório de configuração.

1
herdr plugin config-dir <plugin_id>

plugin action list

Lista as ações dos plugins.

1
herdr plugin action list [--plugin ID]

plugin action invoke

Inicia uma ação registrada.

1
herdr plugin action invoke <action_id> [--plugin ID]

plugin log list

Lista os registros de execução.

1
herdr plugin log list [--plugin ID] [--limit N]

plugin pane open

Abre um painel declarado pelo plugin.

1
herdr plugin pane open --plugin ID --entrypoint ID [--placement overlay|popup|split|tab|zoomed] [--width SIZE] [--height SIZE] [--workspace ID] [--target-pane PANE] [--direction right|down] [--cwd PATH] [--env KEY=VALUE] [--focus|--no-focus]

plugin pane focus

Seleciona o painel do plugin.

1
herdr plugin pane focus <pane_id>

plugin pane close

Fecha o painel do plugin.

1
herdr plugin pane close <pane_id>