docs
Referência

CLI Reference

Referência completa de todos os comandos da Veloz CLI.

Referência de todos os comandos disponíveis na Veloz CLI.

Flag global

--output <format>

Formato de saída para todos os comandos:

  • fancy — Saída colorida com spinners (padrão em terminais interativos)
  • json — JSON estruturado para automação e parsing
  • github-actions — Groups colapsáveis e outputs nativos do GitHub Actions
  • plain — Texto simples sem cores (padrão em CI)
veloz deploy --output json
veloz projects list --output json

Auto-detecção: em GITHUB_ACTIONS=true usa github-actions, em CI=true usa plain.

Também pode ser setado via variável de ambiente:

export VELOZ_OUTPUT=json

Autenticação

veloz login

Autentica via navegador (Device Authorization Flow).

veloz login
veloz login --api-key "chave"     # para CI/automação
veloz login --api-url "https://..." # apontar para outro servidor

No CI, use API key diretamente:

VELOZ_API_KEY=veloz_xxx veloz deploy -y

veloz logout

Remove credenciais salvas.

veloz whoami

Mostra nome e email do usuário autenticado.

Deploy

veloz deploy

Faz deploy do projeto. Detecta framework, cria projeto/serviço se necessário, faz upload e acompanha o build em tempo real.

veloz deploy              # deploy interativo
veloz deploy -y           # auto-confirma tudo (CI/automação)
veloz deploy --all        # deploy de todos os serviços (monorepo)
veloz deploy --service web  # deploy de um serviço específico (por chave ou nome)
veloz deploy --app apps/web # deploy de um app por path (monorepo)
veloz deploy -v           # logs detalhados do servidor

Comportamento:

  1. Detecta repositório git e framework
  2. Se veloz.json existe, usa a configuração salva
  3. Se não, busca projeto pelo GitHub remote ou cria um novo
  4. Faz upload, inicia build e mostra logs em tempo real

Detecção automática

A CLI detecta automaticamente:

  • Framework: Next.js, Nuxt, Remix, SvelteKit, Astro, Hono, Express, Fastify, NestJS, Gatsby, Vite, Angular, Create React App
  • Package manager: npm, pnpm, yarn, bun
  • Comandos de build/start
  • Variáveis de ambiente (lendo .env.example, .env.sample)
  • Monorepo (pnpm workspaces, npm workspaces)

Tipos de serviço

Durante o deploy, a CLI pergunta o tipo:

? Tipo de serviço:
  ❯ Web (HTTP server)
    Static (site estático)
    Worker (background process)
Tipo Use case
Web APIs, Next.js, Express, Hono — qualquer servidor HTTP
Static Sites estáticos, SPAs, landing pages
Worker Filas de jobs, cron jobs, consumidores Kafka/RabbitMQ

Workers rodam em background sem expor porta HTTP — ideais para processamento assíncrono.

Projetos

veloz projects list

Lista todos os projetos da organização.

veloz projects list
veloz projetos listar   # alias pt-BR

Serviços

veloz use [serviço]

Em monorepos, seleciona qual serviço usar como padrão para os outros comandos.

veloz use              # seleção interativa
veloz use api          # seleciona por nome ou chave

Após selecionar, comandos como logs, env, config, domains usam esse serviço automaticamente. Use --service <nome> para sobrescrever pontualmente.

Mostra informações do projeto vinculado (lê veloz.json).

Variáveis de Ambiente

veloz env set <CHAVE=VALOR...>

Define uma ou mais variáveis de ambiente.

veloz env set DATABASE_URL=postgres://...
veloz env set KEY1=val1 KEY2=val2 KEY3=val3
veloz env set SECRET=valor --service api  # para um serviço específico

veloz env list

Lista variáveis (valores mascarados).

veloz env list
veloz env list --service web

veloz env delete <chave>

Remove uma variável.

veloz env import [arquivo]

Importa variáveis de um arquivo .env ou via colagem interativa.

veloz env import .env                 # importar de arquivo
veloz env import .env --replace       # substituir todas existentes
veloz env import                      # modo interativo (cola no terminal)
veloz env import --service api        # para um serviço específico

veloz env export [arquivo]

Exporta variáveis (mascaradas) para terminal ou arquivo.

veloz env export                  # mostra no terminal
veloz env export .env.backup      # salva em arquivo

Domínios

veloz domains add <dominio>

Adiciona um domínio personalizado ao serviço.

veloz domains add meuapp.com
veloz domains add api.meuapp.com --service api

veloz domains list

Lista domínios com status de verificação e TLS.

veloz domains verify <domainId>

Verifica configuração DNS de um domínio.

veloz domains delete <domainId>

Remove um domínio.

Aliases pt-BR: veloz dominios adicionar, veloz dominios listar, veloz dominios verificar, veloz dominios deletar

Configurações

veloz config show

Mostra configurações atuais do serviço.

veloz config show
veloz config show --service api

veloz config set

Altera configurações via flags.

veloz config set --build "npm run build"
veloz config set --start "npm run start"
veloz config set --port 8080
veloz config set --instances 3
veloz config set --cpu 500m --memory 512Mi
veloz config set --branch develop
veloz config set --root apps/web
veloz config set --name "meu-servico"

veloz config edit

Edição interativa de todas as configurações.

veloz config reset

Reseta configurações para os padrões.

veloz config reset --build    # reseta build command
veloz config reset --start    # reseta start command
veloz config reset --all      # reseta tudo

Logs

veloz logs

Visualiza logs dos serviços.

veloz logs                    # últimas 50 linhas
veloz logs --tail 100         # últimas 100 linhas
veloz logs --follow           # streaming em tempo real
veloz logs --service api      # logs de um serviço específico

Em monorepos, logs de múltiplos serviços são exibidos com tags coloridas para fácil identificação.

API Keys

veloz apikey create

Cria uma nova chave de API.

veloz apikey create
veloz apikey create --name "github-actions"
veloz apikey create --no-expire

A chave é exibida uma única vez — guarde em local seguro.

veloz apikey list

Lista todas as chaves de API.

veloz apikey delete <keyId>

Deleta uma chave de API.

Próximos passos