# Referência CLI

Documentação completa dos comandos do deployally.

# Instalação

curl -fsSL https://get.deployally.com/init.sh | sudo bash

Canal de release candidate:

curl -fsSL https://get.deployally.com/init.sh | sudo bash -s -- --rc

Download direto do binário:

# x86_64
curl -Lo deployally https://get.deployally.com/x86_64/deployally
chmod +x deployally
sudo mv deployally /usr/local/bin/

# aarch64
curl -Lo deployally https://get.deployally.com/aarch64/deployally
chmod +x deployally
sudo mv deployally /usr/local/bin/

# Estrutura de Comandos

deployally [comando-global]
deployally <subcomando> [opções]

Comandos globais (--version, self-update) e os comandos de catálogo e deploy (deploy, validate, template new, templates, apikey) ficam todos no nível raiz.

# Comandos Globais

# `--version` / `-V`

Exibe a versão do CLI.

deployally --version

# `--help` / `-h`

Exibe ajuda.

deployally --help
deployally deploy --help

# `self-update`

Atualiza o CLI para a versão mais recente do CDN.

deployally self-update

O comando baixa o binário, valida (-V), substitui e restaura backup se falhar.

# Comandos de Catálogo e Deploy

Tabela rápida:

# `validate`

Valida a estrutura, referências da Reflang e contratos de archetype de um template.

# Sintaxe

deployally validate --species <SPECIES> [opções]

# Opções

# Exit Codes

# Exemplos

# Validar template do catálogo
deployally validate --species memos

# Validar template local antes de publicar
deployally validate --species meu-app --templates-dir ./templates

# Saída JSON (uso programático)
deployally validate --species memos --json

# O que é validado

• Schema do template (campos obrigatórios por archetype)
• Cada referência ${input.X}, ${secrets.X}, etc. tem origem declarada
• Funções da Reflang têm aridade correta
• Healthcheck declarado se archetype exigir (multi_component_saas)
• Rotas HTTP referenciam componentes existentes
• Predicates do ContractIR satisfazem o archetype

# `template new`

Gera um scaffold YAML para um novo template, pronto para edição.

# Sintaxe

deployally template new --archetype <A> --species <S> [opções]

# Opções

# Exemplos

# Application simples
deployally template new \
  --archetype application \
  --species memos-clone \
  --image neosmemo/memos:0.20 \
  --port 5230 \
  --out memos-clone.yaml

# Asset com dispatcher para criação de databases
deployally template new \
  --archetype asset \
  --species meu-db \
  --image meu-org/db:latest \
  --port 5432 \
  --data-path /var/lib/db \
  --provision-action create-database \
  --out meu-db.yaml

# Multi-component SaaS
deployally template new \
  --archetype multi_component_saas \
  --species meu-saas \
  --out meu-saas.yaml

# `deploy`

Faz deploy de uma instance do template.

# Sintaxe

deployally deploy --species <S> --instance-uid <UID> [opções]

# Opções

# Exemplos

# Deploy básico
deployally deploy --species memos \
  --instance-uid memos-001 \
  --input WEB_HOSTNAME=memos.exemplo.com \
  --apply

# Dry-run pra ver o que seria feito
deployally deploy --species memos \
  --instance-uid memos-001 \
  --input WEB_HOSTNAME=memos.exemplo.com \
  --dry-run

# Com profile de produção
deployally deploy --species mysql \
  --instance-uid mysql-prod \
  --profile production \
  --apply

# Variant específico (MySQL 5.7 em vez de 8.4)
deployally deploy --species mysql \
  --instance-uid mysql-legacy \
  --variant mysql-5.7 \
  --apply

# Auto-provisão de banco para WordPress
deployally deploy --species wordpress \
  --instance-uid blog-001 \
  --input WEB_HOSTNAME=blog.exemplo.com \
  --input ADMIN_EMAIL=admin@exemplo.com \
  --provision-missing-assets \
  --apply

# Deploy de template local
deployally deploy --species meu-app \
  --instance-uid meu-app-001 \
  --templates-dir ./templates \
  --source local \
  --apply

# Modo offline (não fala com registry)
deployally deploy --species memos \
  --instance-uid memos-001 \
  --offline \
  --apply

# Pipeline de Execução

1. Fetch: busca o template (local → cache → registry, exceto se --offline)
2. Build context: aplica defaults dos inputs declarados; merge com --input
3. Wizard: pede o que falta (compactado por prefixo); pula em --input exaustivos
4. Reflang resolve: substitui ${...} em todas as seções
5. Validate: ContractIR + predicates do archetype
6. Archetype defaults merge: aplica networks, labels CCS, restart policy
7. Preflight: DNS, port conflicts, network existence
8. Auto-provision (se --provision-missing-assets): sobe assets faltantes em cascata
9. Apply: cria volumes, networks, containers (Docker SDK)
10. Wait healthy: poll do healthcheck declarado com retry

# `undeploy`

Remove uma instance criada por deploy — é a operação inversa. Dry-run é o default: sem --apply, o comando só imprime o plano de remoção, sem tocar em nada.

# Sintaxe

deployally undeploy --instance-uid <UID> [opções]

# Opções

# Exemplos

# Preview (dry-run — não toca em nada)
deployally undeploy --instance-uid memos-001

# Remove containers + registro, preservando dados (redeploy volta com tudo)
deployally undeploy --instance-uid memos-001 --apply

# Remoção total (irreversível) — exige digitar o instance_uid ou --yes
deployally undeploy --instance-uid memos-001 --apply --purge-data --yes

# Saída máquina para integração (CCS)
deployally undeploy --instance-uid memos-001 --apply --purge-data --yes -o json

# O que nunca é removido

• Volumes kind: bind (paths de sistema)
• A rede public
• Assets compartilhados ou bancos de tenant (declarados em deps[])
• Containers que não têm a label ccs.systems/uid da instance

# Undeploy é local

Uma instance removida localmente ainda pode estar registrada no servidor: rodar deploy de novo com o mesmo --instance-uid reprovisiona tudo (mesmos secrets, mesmos volumes). Para desativação definitiva, desregistre a instance no servidor.

# Arquivo de Configuração

Localização padrão: /opt/deployally/config.yaml

api:
  url: https://sys.deployally.com
  api_key: da_xxx

defaults:
  source: remote
  profile: development

logging:
  level: info

# Variáveis de Ambiente

# Exit Codes Globais

# Próximos Passos

• Reflang Reference — sintaxe completa da linguagem de template
• Getting Started — primeiro deploy
• Templates — como funcionam os archetypes
• Integração API — uso programático (restrito)