Spraxium logoSpraxium

Visão Geral da CLI

A CLI do Spraxium oferece sete comandos que cobrem todo o ciclo de desenvolvimento. Entenda quando usar cada um e como eles se conectam, da criação do projeto à produção.

Para que serve a CLI

A CLI é o caminho mais curto entre um projeto limpo e um bot pronto para rodar. Ela cuida de scaffolding, geração de arquivos, inicialização em desenvolvimento, builds de produção, execução em runtime, integração com banco de dados e diagnósticos, tudo por meio de uma interface consistente. Essa consistência importa porque é justamente na linha de comando que os times costumam perder tempo com etapas repetidas, desvios de nomenclatura ou fluxos meio manuais.

Na prática, a CLI funciona melhor quando cada comando tem uma responsabilidade clara. new cria o workspace, generate adiciona arquivos alinhados ao framework, dev roda o bot em atividade, build valida a saída de produção e start executa o artefato compilado. Os comandos restantes dão suporte a fluxos adjacentes, como configuração de banco de dados e diagnóstico do ambiente.

Comandos disponíveis

A CLI oferece sete comandos. Cada um atende a uma etapa diferente do ciclo de vida do projeto, desde a criação de um projeto novo até a execução do artefato compilado em produção.

Como os comandos se encaixam

Pense na CLI como um ciclo, não como um conjunto de comandos soltos:

  1. new cria a estrutura inicial do projeto.
  2. generate mantém os novos arquivos alinhados às convenções do framework.
  3. dev entrega o ciclo de feedback mais rápido durante a implementação.
  4. build é a etapa de qualidade antes de compartilhar ou implantar.
  5. start executa exatamente o artefato de produção que você acabou de gerar.
  6. database e info dão suporte à configuração e ao troubleshooting em torno desse fluxo.

Fluxo diário recomendado

A maioria dos times usa apenas parte da CLI no dia a dia. O ritmo mais comum é criar o projeto uma vez, gerar arquivos conforme necessário, permanecer em dev durante a implementação e usar build como verificação final antes de publicar.

Crie com new

Rode spraxium new uma vez para criar o projeto. Escolha o template e os módulos opcionais durante o assistente interativo.

Gere com generate

Use spraxium generate para adicionar módulos, serviços, listeners ou comandos. A CLI coloca os arquivos na pasta correta e faz o registro automático.

Itere com dev

Rode spraxium dev durante a implementação. Os arquivos recarregam automaticamente ao salvar, então você vê o resultado na hora.

Valide com build

Rode spraxium build antes de enviar para qualquer ambiente compartilhado. Erros de tipos e falhas de bundle aparecem aqui, não em produção.

Execute com start

Rode spraxium start em staging e produção depois de um build bem-sucedido. Ele lê diretamente a saída compilada.

Uso local versus CI

No desenvolvimento local, o foco costuma estar em generate e dev. Em CI, o interesse normalmente fica em build e, em alguns cenários de depuração, em info --json. Manter essa separação clara ajuda a evitar o uso forçado de comandos interativos em automação ou a dependência de comportamentos exclusivos de desenvolvimento em pipelines de produção.

Como escolher o comando certo rapidamente

Se você estiver em dúvida sobre qual comando rodar, use este atalho:

  1. Precisa de um projeto novo: rode spraxium new.
  2. Precisa de um novo arquivo do framework: rode spraxium generate.
  3. Precisa de recarga ao vivo enquanto programa: rode spraxium dev.
  4. Precisa de um artefato pronto para deploy: rode spraxium build.
  5. Precisa executar o artefato gerado: rode spraxium start.
  6. Precisa de contexto sobre o ambiente: rode spraxium info.