Runner CI/CD Documentação 25424bc

Referencia CLI

O Runner oferece uma CLI completa para gerenciamento de deploys.

Comandos Principais

Inicializacao e Registro

Comando Descricao
runner init Inicializa ambiente Runner
runner add --repo user/repo [--instance NAME] Registra nova aplicacao (v1.5.0: --instance)
runner list [--detailed] Lista apps registradas

Deploy e Rollback

Comando Descricao
runner deploy <app> Executa deploy
runner deploy --all Deploya todas as apps registradas
runner rollback --app /path Rollback para versao anterior
runner reset --app /path Reset completo (wipe + redeploy)
runner fetch [--deploy] Busca atualizacoes

Gerenciamento de Instancias

Comando Descricao
runner instances <project> Lista instancias
runner versions <project> -i <inst> Lista versoes
runner destroy <project> -i <inst> Remove instancia
runner cleanup [--expired] [--orphans] [--prs] [--images] [--build-cache] Limpa recursos

Canary Deployment

Comando Descricao
runner weights <project> -i <inst> Mostra distribuicao de trafego
runner weight <proj> <inst> <ver> <pct> Ajusta peso
runner promote <project> -i <inst> <ver> Promove para 100%
runner canary status <proj> -i <inst> Status do scheduler (v1.2.0)
runner canary pause <proj> -i <inst> Pausa auto-promocao (v1.2.0)
runner canary resume <proj> -i <inst> Retoma auto-promocao (v1.2.0)
runner canary abort <proj> -i <inst> Aborta canary (v1.2.0)

Network / Portas (v2.19.0)

Comando Descricao
runner ports list [--json] Lista portas alocadas (sticky) por app
runner ports release <app> Libera todo state.network (mantém container)
runner ports realloc <app> Limpa só published_port — proxima deploy realoca
runner deploy <app> --port N Override permanente de porta (one-shot)
runner deploy <app> --no-port Desabilita port mapping (strategy=none) so desta deploy

PR Deploy (v2.0.0)

Comando Descricao
runner add --repo R --pr N --branch B Registra PR deploy vinculado a app existente
runner remove <app> --pr N Remove PR deploy (container + traefik + state)

Staging de PRs (legacy)

Comando Descricao
runner stage deploy --repo user/repo --pr N Deploy de PR
runner stage list [--json] Lista stagings
runner stage destroy --id <id> Remove staging
runner stage cleanup Limpa expirados

Environment

Comando Descricao
runner env status --app /path Mostra variaveis
runner env set --app /path --key K --value V Define variavel
runner env set ... --secret Define secret
runner env validate --app /path --required "A,B" Valida variaveis

Logs

Comando Descricao
runner logs history --app /path Historico de deploys
runner logs tail --app /path Ultimas linhas
runner logs stats --app /path Estatisticas

Notificacoes (v1.4.0)

Comando Descricao
runner notify setup Setup interativo de notificacoes
runner notify setup --channel telegram Setup Telegram
runner notify setup --channel discord Setup Discord
runner notify setup --channel both Setup ambos
runner notify test Envia notificacao de teste
runner notify status Mostra status dos canais

Config Templates (v2.0.0)

Comando Descricao
runner config set <app> <key> <value> Define valor em values.local.yaml
runner config get <app> <key> [--instance X] Le valor resolvido
runner config diff <app> [--instance X] Diff entre camadas
runner config reset <app> Remove values.local.yaml

Configuracao

Comando Descricao
runner edit <app> --branch <br> Altera branch trackeada (v1.2.2)
runner edit <app> --instance <name> Define instancia de deploy (v1.5.0)
runner edit <app> --show Mostra config atual (v1.2.2)
runner generate-config Gera template .deploy.yml
runner validate --file /path Valida configuracao
runner upgrade --path /path Migra formato legado
runner migrate --app /path Migra estrutura de app

MCP Server

Comando Descricao
runner mcp serve Inicia servidor MCP
runner mcp install Instala config MCP
runner mcp uninstall Remove config MCP
runner mcp status Mostra info do servidor

Service Mode (v2.2.0)

Comando Descricao
runner service init [--port N] Instala como servico systemd (gera service.yml + unit)
runner service start Inicia servico
runner service stop Para servico
runner service restart Reinicia servico
runner service status Mostra status + config
runner service config [--port N] [--api-key] Altera configuracao
runner service uninstall Remove servico

Signals (v2.2.0)

Comando Descricao
runner signal send <app> --status fail --message "..." Envia signal (CI/CD)
runner signal send <app> --status ok --message "..." Signal de sucesso
runner signal send <app> --status fail --action abort Signal com acao
runner signal clear <app> Limpa signal (desbloqueia canary)
runner signal list Lista signals ativos

Triggers / Serve

Comando Descricao
runner serve --service Service mode (v2.2.0): le service.yml, API + scheduler
runner serve Legacy: webhook server + canary scheduler
runner serve --mode webhook Apenas webhook server
runner serve --mode cron Apenas canary scheduler
runner serve --port 9000 Porta customizada

Self-Update

Comando Descricao
runner self-update Atualiza para versao estavel
runner self-update --force Forca reinstalacao
runner self-update --channel rc Usa release candidate
runner self-update --check Apenas verifica (nao baixa)

Flags Globais

Flag Descricao
--help Mostra ajuda
--version Mostra versao
--json Output em JSON

Filtros por Labels (v1.2.0)

O comando list suporta filtragem por labels CCS:

runner list --project=meu-app
runner list --instance=production
runner list --project=frontend-* --json

Labels CCS usadas:

  • ccs.systems/project
  • ccs.systems/instance
  • ccs.systems/version

Exemplos Rapidos 

# Primeiro uso
runner init
runner add --repo usuario/meu-app --ckey "minha-chave-secreta"

# Deploy
runner fetch --deploy
runner deploy meu-app

# Deploy todas as apps (recovery)
runner deploy --all

# Rollback
runner rollback --app /data/apps/usuario_meu-app

# Canary manual
runner deploy meu-app --version v1.1.0
runner weight meu-app production v1.1.0 10
runner promote meu-app -i production v1.1.0

# Notificacoes (v1.4.0)
runner notify setup --channel telegram # Setup interativo
runner notify test                     # Testar envio
runner notify status                   # Ver status

# Canary automatico (v1.2.0)
runner serve                           # Inicia scheduler
runner canary status meu-app -i prod   # Ver progresso
runner canary pause meu-app -i prod    # Pausar
runner canary abort meu-app -i prod    # Abortar

# Staging
runner stage deploy --repo usuario/meu-app --pr 42
runner stage list
runner stage destroy --id staging_meu-app_pr42

# MCP
runner mcp install
runner mcp status

# Filtros (v1.2.0)
runner list --project=frontend
runner list --instance=staging --json

# Editar config de app (v1.2.2)
runner edit runner-docs/front --show       # Ver config atual
runner edit runner-docs/front --branch dev # Mudar para branch dev

Documentacao Detalhada

  • add - Registrar nova aplicacao (incl. --force-duplicate v2.21.0+)
  • deploy - Comando de deploy
  • rollback - Comando de rollback
  • fetch - Comando de fetch
  • edit - Editar config de app (v1.2.2)
  • serve - Servidor webhook/cron/service mode
  • instances - Gerenciamento de instancias
  • staging - Staging de PRs
  • environment - Variaveis de ambiente
  • ports - Gerenciamento de portas alocadas (v2.19.0)
  • mcp - Servidor MCP
  • self-update - Auto-atualizacao
By Borlot.com.br on 16/02/2026

Tags

cli comandos referencia