Requisitos e instalação

O slash-kit é um CLI, o comando slash, que cria, confere e verifica projetos de landing, site e blog. A versão 1.1.0 não tem instalador: você obtém o código na tag v1.1.0 e roda o CLI a partir dele.

Requisitos

• Bun 1.4.3. Roda o CLI e os projetos gerados. É a versão fixada nos tipos do repositório e a que o guia de VPS do blog instala.
• git. O slash create cria o repositório do projeto com um commit inicial, e o slash approve assina a liberação com o nome do git. Configure os dois com git config --global user.name "Seu Nome" e git config --global user.email "voce@exemplo.com".
• GitHub CLI (gh). Só para slash create --github. Sem essa opção, não é preciso.
• Acesso ao slash-ssg. O slash create clona o slash-ssg na tag v0.0.6, por SSH, e roda bun install no projeto novo. Precisa de rede e de uma chave SSH com acesso a esse repositório.
• Chromium do Playwright. O slash verify usa o Chromium nos testes E2E, na regressão visual e no Lighthouse. Instale-o no projeto gerado com bunx playwright install chromium. O slash create não instala o navegador. Cada worker do Playwright segura um Chromium de cerca de 200 MB; o verify usa dois por padrão, e a variável SLASH_VERIFY_WORKERS muda esse número.

Obter o código

1. Clone o repositório rrbashell/slash-kit.
2. Entre na tag v1.1.0, por exemplo com git checkout v1.1.0. O slash create lê a versão do código com git describe --tags, então o clone precisa trazer as tags.
3. Rode bun install dentro do checkout. O CLI importa happy-dom e @playwright/test.
4. Confira que ui/ e templates/ não têm mudança sem commit (no template blog, também panel/ e modules/). Se tiverem, o slash create recusa e mostra os arquivos, porque a versão gravada no projeto não seria a da tag.

Rodar o CLI

Há duas formas, e os exemplos desta documentação valem para as duas.

• Pelo caminho do checkout: bun <caminho-do-checkout>/cli/bin.ts <comando>. Use essa forma se não quiser registrar o comando.
• Como slash: bun link na raiz do checkout registra o bin slash declarado no package.json. Depois disso, slash <comando> funciona no terminal.

O pacote é privado, então não há versão publicada para instalar com bun add -g.

Confira a instalação com slash --help. A saída é esta:

uso: slash <comando> [opções]

  slash create <pasta> [--template landing-page|one-page|multi-page|blog] [--model <modelo>] [--modules <id,…>] [--github owner/repo]
  slash check [--watch]
  slash approve
  slash verify [--background] [--update-baseline] [--if-changed]
  slash module list [--dir <pasta>]
  slash module add <id> [--dir <pasta>]
  slash backup [--restore <arquivo>] [--dir <pasta>]
  slash admin create --email <e-mail> [--dir <pasta>]
[saída: 0]

Próximo passo: Primeiro projeto.