AxiomOS

CLI para instalar e manter a estrutura AxiomOS em projetos de software.

Instalação

Uso direto com npx:

npx @allanrobert10/axiomos init

Ou instalação global:

npm install -g @allanrobert10/axiomos
axiomos --help

O que a v2 entrega

• prompts interativos no init e no update
• presets de inicialização (base, saas, api)
• backup automático antes de sobrescrever docs/
• geração de README.md do projeto alvo
• docs/README.md para orientar o uso do AxiomOS dentro do projeto inicializado
• diagnóstico com doctor --verbose
• preview de mudanças antes do update
• modo --force para sobrescrita direta sem backup

Estrutura

axiomos/
├── package.json
├── README.md
├── bin/
│   └── axiomos.js
├── src/
│   ├── commands/
│   │   ├── init.js
│   │   ├── doctor.js
│   │   └── update.js
│   └── utils/
│       ├── args.js
│       ├── fs.js
│       ├── logger.js
│       ├── project.js
│       ├── prompts.js
│       └── readme.js
└── templates/
    └── docs/

Comandos

init

Inicializa docs/ no projeto atual, preserva arquivos existentes, aplica preset e pode gerar README.md.

npx @allanrobert10/axiomos init
npx @allanrobert10/axiomos init --project-name MinhaApp --preset saas
npx @allanrobert10/axiomos init --yes --project-name MinhaAPI --preset api

Flags:

• --project-name <nome>: nome usado no README.md gerado
• --preset <base|saas|api>: define o preset inicial
• --yes: executa sem prompts interativos

doctor

Verifica se todos os arquivos obrigatórios estão presentes em docs/.

npx @allanrobert10/axiomos doctor
npx @allanrobert10/axiomos doctor --verbose

Flags:

• --verbose: lista todos os arquivos verificados e os presets disponíveis

update

Sincroniza docs/ com templates/docs, mostra preview das mudanças, pede confirmação e cria backup automático antes de sobrescrever.

npx @allanrobert10/axiomos update
npx @allanrobert10/axiomos update --yes
npx @allanrobert10/axiomos update --force
npx @allanrobert10/axiomos update --backup-dir .backups/axiomos

Flags:

• --yes: pula a confirmação interativa
• --force: sobrescreve direto, sem prompt e sem criar backup
• --backup-dir <dir>: define o diretório de backup

Presets

base

Preset padrão para adoção geral do AxiomOS.

saas

Focado em produto SaaS, arquitetura web, operação contínua e custo.

api

Focado em APIs, contratos, validação e regressão.

Desenvolvimento local

node ./bin/axiomos.js --help
npm test
npm run doctor:verbose

O npm test executa testes automatizados de integração do CLI.

CI

O repositório possui GitHub Actions configurado para rodar npm test automaticamente em push para main e em pull_request.

Publicação automatizada

O repositório também possui workflow de publicação em .github/workflows/publish.yml.

Para ativar o publish automático no GitHub Actions, configure o secret do repositório:

• NPM_TOKEN: token do npm com permissão para publicar @allanrobert10/axiomos

Depois disso, a publicação pode ser disparada por:

• workflow_dispatch
• criação de release publicada no GitHub

Pacote publicado

• npm: @allanrobert10/axiomos
• versão atual: 1.0.3

Licença

MIT