runner snapshot
Emite um JSON compacto com todos os projetos registrados, o status atual dos containers e o historico de deploys. Inclui projetos sem container rodando. Projetado para coleta periodica pelo CCS client (Runner collector).
Use quando: voce quer inspecionar o estado geral de todos os projetos de um servidor de uma vez, ou integrar o Runner a um sistema de monitoramento externo.
Sintaxe
runner snapshot [PROJECT] [flags]Argumentos e flags
| Argumento/Flag | Default | Descricao |
|---|---|---|
[PROJECT] |
— | Nome de um projeto especifico (opcional) |
--all |
— | Snapshot de todos os projetos (explicito) |
-o, --output <FORMAT> |
human |
Formato de saida: human, json, yaml |
-h, --help |
— | Exibe ajuda |
Sem argumentos, o comportamento e equivalente a --all (compatibilidade
retroativa).
Exemplos
Snapshot de todos os projetos
runner snapshot
# equivalente a:
runner snapshot --allSaida compacta com status de cada projeto:
PROJECT STATUS VERSION CONTAINER LAST_DEPLOY
cdn-front running v2.4.1 healthy 2026-05-26T10:00Z
cdn-sys running v1.9.0 healthy 2026-05-25T08:30Z
staging-front stopped v2.3.0 - 2026-05-20T14:00ZSnapshot de um projeto especifico
runner snapshot cdn-frontRetorna o estado somente daquele projeto, com historico de deploys incluido.
Nome de exibição (v2.157.0+)
Cada item de projects[] e de instances[] traz display_name: o nome
gravado com `runner app rename`, ou null quando a app não tem
nome. O campo está sempre presente.
Saida JSON para integracao
runner snapshot --output json{
"collected_at": "2026-05-27T14:30:00Z",
"projects": [
{
"project": "cdn-front",
"status": "running",
"version": "v2.4.1",
"container_status": "healthy",
"last_deploy": "2026-05-26T10:00:00Z"
},
{
"project": "staging-front",
"status": "stopped",
"version": "v2.3.0",
"container_status": null,
"last_deploy": "2026-05-20T14:00:00Z"
}
]
}Campos de source (v2.50.0)
Cada project — e cada entrada da lista flat instances[] — carrega os
campos de origem quando o app tem bloco github: no manifesto:
| Campo | Exemplo | Uso |
|---|---|---|
repo |
devborlot/meu-app |
Coluna SOURCE no CCS + link pro repo |
branch |
dist |
Branch de artefatos acompanhada |
vcs_provider |
github |
Montar a URL externa |
slug |
devborlot/meu-app |
Identificação do project |
Omitidos (não null) quando não há github: — aditivo e retrocompatível.
Uso pelo CCS collector
O runner snapshot e o endpoint principal consumido pelo agente CCS para
inventario de servidores. A coleta e feita periodicamente via SSH ou MCP,
sem impacto nos containers em execucao.
Erros comuns
project not found— O nome passado como argumento nao corresponde a nenhum projeto registrado; verifique comrunner list.- Saida vazia (sem projetos) — Nenhum projeto foi registrado neste servidor ainda;
use
runner addpara registrar o primeiro.