@nymeria-sys/cli
v1.2.0
Published
Nymeria CLI — scaffold, publish e activate de MFEs na plataforma Nymeria.
Maintainers
Readme
@nymeria-sys/cli
Nymeria CLI — scaffold, publish e activate de Micro Frontends (MFEs) e websites públicos na plataforma Nymeria, mais sync de scripts do backend.
Instalação
npm install -g @nymeria-sys/cliOu execute pontualmente sem instalar:
npx @nymeria-sys/cli --helpComandos
Setup e autenticação
| Comando | Descrição |
|---|---|
| nymeria init | Aponta o diretório pra uma instância (escreve .nymeriarc.json) e pergunta o escopo do projeto |
| nymeria login | Autentica em uma instância Nymeria via OAuth PKCE |
| nymeria logout | Limpa credenciais salvas |
| nymeria whoami | Mostra o usuário autenticado |
Pino de escopo do projeto
"scope" no .nymeriarc.json pina o escopo do projeto: tudo que a pasta
publica (mfe publish, website publish) ou cria via MCP local nasce nele,
independente do escopo atual da sessão. Um rc na pasta mãe cobre todos os MFEs
dentro (walk-up). Prioridade: --scope → NYMERIA_SCOPE → rc.
| Comando | Descrição |
|---|---|
| nymeria scope show | Mostra o pino e de onde veio |
| nymeria scope set [id] | Pina (picker interativo sem argumento; valida o id quando passado) |
| nymeria scope audit [--fix] | Confere artefatos do projeto contra o pino; --fix re-carimba |
MFEs
| Comando | Descrição |
|---|---|
| nymeria mfe init | Scaffolda um novo MFE React (webpack + Module Federation + dev harness) |
| nymeria mfe init-mfe-config | Cria/atualiza nymeria.mfe.mjs em projeto existente |
| nymeria mfe publish | Hash + upload + cria release de uma versão do MFE |
| nymeria mfe unpublish | Remove release e arquivos associados |
| nymeria mfe activate | Ativa um release em uma instância/ambiente |
| nymeria mfe deactivate | Desativa um MFE em uma instância/ambiente |
| nymeria mfe list-active | Lista releases ativos |
| nymeria mfe releases-list | Lista releases publicados de um app |
| nymeria mfe manifest-inspect | Mostra o manifest atual da instância |
| nymeria mfe set-vars | Define theme vars override |
Websites públicos ({inst}.nym.net.br/{slug})
| Comando | Descrição |
|---|---|
| nymeria website init | Scaffold de site multi-página (Tailwind + tema da instância) |
| nymeria website dev | Preview local com watch, tema real e scripts via proxy ou mock |
| nymeria website publish | Builda e publica: release de assets + versão DRAFT por página alterada |
| nymeria website activate | Ativa versão de página (draft vira published; rollback = ativar versão antiga) |
| nymeria website versions | Histórico de versões de uma página |
| nymeria website list | Páginas do site com estado (no ar, draft pendente, órfã) |
| nymeria website unpublish | Tira do ar uma página (--page) ou o site inteiro |
Sync de scripts
| Comando | Descrição |
|---|---|
| nymeria pull | Baixa scripts/configs do backend pra arquivos locais (--type, --scope) |
| nymeria push | Sobe alterações locais pro backend (--type, --scope, --force) |
Use nymeria <comando> --help para detalhes de cada um.
Exemplo: scaffold + publish de um MFE
mkdir my-mfe && cd my-mfe
nymeria mfe init --yes \
--mfe-key mfeMyForm \
--name "My Form" \
--path /my-form \
--port 4030
pnpm install
nymeria login
nymeria mfe publish
nymeria mfe activate --mfe-key mfeMyForm --version 1.0.0 \
--instance-id <instance-id> --env devExemplo: website público
mkdir meu-site && cd meu-site
nymeria website init --slug docs
pnpm install
nymeria login
nymeria website dev # preview local em http://localhost:4400
nymeria website publish # cria versões DRAFT das páginas alteradas
nymeria website activate --allRequisitos
- Node.js >= 18
- Acesso a uma instância Nymeria (URL + credenciais OAuth)
Licença
UNLICENSED
