Referência CLI
Guia completo de todos os comandos disponíveis no DeployAlly CLI.
Instalação
curl -fsSL https://get.deployally.com | bashOu download manual:
curl -Lo deployally https://get.deployally.com/releases/latest/deployally
chmod +x deployally
sudo mv deployally /usr/local/bin/Estrutura de Comandos
deployally <comando> [subcomando] [opções]Comandos Globais
--version
Exibe a versão do CLI.
deployally --version--help
Exibe ajuda do comando.
deployally --help
deployally deploy --help--config
Especifica arquivo de configuração alternativo.
deployally --config /path/to/config.toml deployComandos Principais
| Comando | Descrição |
|---|---|
init |
Configura o CLI |
list |
Lista templates disponíveis |
deploy |
Faz deploy de um template |
status |
Mostra status dos containers |
definitions |
Gerencia definitions |
instances |
Gerencia instances |
sync |
Sincroniza estado |
self-update |
Atualiza o CLI para última versão |
init
Configura o CLI para uso.
Sintaxe
deployally init [opções]Opções
| Opção | Descrição |
|---|---|
--api-url |
URL da API DeployAlly |
--api-key |
Chave de API |
--local |
Modo offline (sem API) |
--server-name |
Nome do servidor |
--environment |
Ambiente (development, production) |
Exemplos
# Configurar com API
deployally init \
--api-url https://sys.deployally.com \
--api-key da_xxx
# Modo local/offline
deployally init --locallist
Lista templates disponíveis.
Sintaxe
deployally list [opções]Opções
| Opção | Descrição |
|---|---|
--source |
Origem: remote (padrão) ou local |
--kingdom |
Filtrar por kingdom |
--family |
Filtrar por family |
--species |
Filtrar por species |
--json |
Saída em JSON |
Exemplos
# Listar todos os templates
deployally list
# Listar apenas bancos de dados
deployally list --family database
# Listar MySQL
deployally list --species mysql
# Templates locais
deployally list --source local
# Saída JSON
deployally list --jsondeploy
Faz deploy de um template.
Sintaxe
deployally deploy [opções]Opções
| Opção | Descrição |
|---|---|
--species |
Species do template (obrigatório) |
--version |
Versão específica |
--variant |
Variante do template |
--source |
Origem: remote ou local |
--profile |
Profile: minimal, development, production |
--name |
Nome customizado para o container |
--yes |
Confirma automaticamente |
Exemplos
# Deploy interativo
deployally deploy --species mysql
# Deploy com versão específica
deployally deploy --species mysql --version 8.4
# Deploy com profile de produção
deployally deploy --species mysql --version 8.4 --profile production
# Deploy sem confirmação
deployally deploy --species redis --yesstatus
Mostra status dos containers.
Sintaxe
deployally status [opções]Opções
| Opção | Descrição |
|---|---|
--all |
Mostra todos (incluindo parados) |
--json |
Saída em JSON |
Exemplos
# Status resumido
deployally status
# Incluir containers parados
deployally status --all
# Saída JSON
deployally status --jsondefinitions
Gerencia definitions.
Subcomandos
| Subcomando | Descrição |
|---|---|
list |
Lista definitions |
show |
Mostra detalhes |
update |
Atualiza definition |
delete |
Remove definition |
history |
Histórico de revisões |
rollback |
Volta para revisão anterior |
Exemplos
# Listar definitions
deployally definitions list
# Ver detalhes
deployally definitions show mysql_meu_banco
# Atualizar profile
deployally definitions update mysql_meu_banco --profile production
# Ver histórico
deployally definitions history mysql_meu_banco
# Rollback
deployally definitions rollback mysql_meu_banco --revision 1
# Remover
deployally definitions delete mysql_meu_bancoinstances
Gerencia instances (containers).
Subcomandos
| Subcomando | Descrição |
|---|---|
list |
Lista instances |
logs |
Mostra logs |
restart |
Reinicia container |
stop |
Para container |
start |
Inicia container |
exec |
Executa comando no container |
Exemplos
# Listar instances
deployally instances list
# Ver logs
deployally instances logs mysql_meu_banco
# Logs em tempo real
deployally instances logs mysql_meu_banco --follow
# Reiniciar
deployally instances restart mysql_meu_banco
# Executar comando
deployally instances exec mysql_meu_banco -- mysql -u root -psync
Sincroniza estado entre definitions e instances.
Sintaxe
deployally sync [opções]Opções
| Opção | Descrição |
|---|---|
--check |
Apenas verifica, não corrige |
--fix |
Corrige diferenças encontradas |
--dry-run |
Mostra o que seria feito |
Exemplos
# Verificar drift
deployally sync --check
# Corrigir diferenças
deployally sync --fix
# Ver o que seria feito
deployally sync --fix --dry-runself-update
Atualiza o CLI para a versão mais recente.
Sintaxe
deployally self-update [opções]Opções
| Opção | Descrição |
|---|---|
-c, --check |
Apenas verifica, não baixa |
-f, --force |
Força reinstalação mesmo se já está na última |
-p, --path |
Caminho de instalação (default: /usr/local/bin/deployally) |
-u, --url |
URL alternativa para download |
--channel |
Canal: stable (default) ou rc |
Exemplos
# Atualizar para última versão
deployally self-update
# Verificar se há atualização (sem baixar)
deployally self-update --check
# Forçar reinstalação
deployally self-update --force
# Usar canal de release candidate
deployally self-update --channel rc
# Especificar caminho de instalação
deployally self-update --path /opt/bin/deployallySaída
════════════════════════════════════════════════════════════
DEPLOYALLY SELF-UPDATE
════════════════════════════════════════════════════════════
Versão atual: 0.8.10
Canal: stable
Destino: /usr/local/bin/deployally
Baixando versão mais recente...
✓ Atualização concluída!
Nova versão: deployally 0.9.0
════════════════════════════════════════════════════════════Processo de Atualização
- Verifica versão atual
- Baixa binário do servidor de releases
- Verifica integridade (tamanho mínimo 1MB)
- Testa execução do binário baixado
- Cria backup do binário atual
- Substitui pelo novo binário
- Define permissões (755)
- Remove backup após sucesso
Se qualquer verificação falhar, o backup é restaurado automaticamente.
Arquivo de Configuração
Localização: ~/.config/deployally/config.toml
[api]
url = "https://sys.deployally.com"
api_key = "da_xxx"
[server]
name = "meu-servidor"
environment = "production"
[defaults]
source = "remote"
profile = "development"
[logging]
level = "info"Exit Codes
| Código | Significado |
|---|---|
| 0 | Sucesso |
| 1 | Erro genérico |
| 2 | Erro de configuração |
| 3 | Erro de conexão |
| 4 | Erro de autenticação |
| 5 | Recurso não encontrado |
Variáveis de Ambiente
| Variável | Descrição |
|---|---|
DEPLOYALLY_API_URL |
URL da API |
DEPLOYALLY_API_KEY |
Chave de API |
DEPLOYALLY_CONFIG |
Path do config |
DEPLOYALLY_LOG_LEVEL |
Nível de log |
Próximos Passos
- Getting Started - Primeiro deploy
- Templates - Como funcionam os templates
- Integração API - Uso programático (restrito)
By Borlot.com.br on 13/02/2026