cli-aspen
TypeScript icon, indicating that this package has built-in type declarations

0.1.0 • Public • Published

Aspen

Aspen é uma ferramenta de linha de comando moderna para criar projetos backend com opções personalizáveis.

Aspen CLI

Características

  • 🚀 Criação rápida de projetos backend
  • 🛠️ Suporte para vários frameworks: Express, Fastify, NestJS, Hono, AdonisJS
  • 📊 Integração com diversos ORMs: Prisma, TypeORM, Mongoose, Drizzle, Sequelize, Lucid (AdonisJS)
  • 🗄️ Suporte para diferentes bancos de dados: PostgreSQL, MySQL, SQLite, MongoDB
  • 📦 Utiliza os CLIs nativos dos frameworks quando disponíveis
  • 🔧 Configuração personalizada de recursos adicionais
  • 🎨 Interface de linha de comando intuitiva e bonita

Instalação

Instalação via npm (recomendado)

# Instalação global via npm
npm install -g @mateus.devlp/aspencli

# Ou via yarn
yarn global add @mateus.devlp/aspencli

# Ou via pnpm
pnpm add -g aspen-cli

Instalação rápida via script

# Instalação rápida via curl
curl -fsSL https://raw.githubusercontent.com/username/aspen/main/install.sh | bash

Uso

Criar um novo projeto

# Criar um novo projeto com assistente interativo
aspen create my-project

# Criar um projeto especificando diretório
aspen create my-project --directory ./projects

# Criar um projeto com template específico
aspen create my-project --template express-typescript

Listar templates disponíveis

aspen list

Inicializar Aspen em um projeto existente

# Navegue até o diretório do projeto existente
cd meu-projeto-existente

# Inicializar Aspen
aspen init
# Criar um novo projeto
aspen create my-backend-project

# Obter ajuda
aspen --help

Opções de Criação de Projeto

Ao criar um novo projeto, você pode personalizar:

  • Linguagem: TypeScript ou JavaScript
  • Framework: Express, Fastify, NestJS, Hono, AdonisJS
  • ORM: Prisma, TypeORM, Mongoose, Drizzle, Sequelize, Lucid (AdonisJS) ou nenhum
  • Banco de Dados: PostgreSQL, MySQL, SQLite, MongoDB ou nenhum
  • Recursos Adicionais:
    • ESLint
    • Prettier
    • Biome
    • Jest
    • Docker
    • Swagger/OpenAPI
    • Autenticação JWT
    • Limitação de taxa
    • CORS
    • Helmet
    • Winston (logging)
    • e mais...

Estrutura do Projeto Gerado

my-backend-project/
├── src/
│   ├── controllers/     # Controladores da aplicação
│   ├── models/          # Modelos de dados
│   ├── routes/          # Definição de rotas
│   ├── middlewares/     # Middlewares
│   ├── services/        # Serviços da aplicação
│   ├── utils/           # Utilitários
│   ├── config/          # Configurações
│   └── index.ts         # Ponto de entrada da aplicação
├── .env                 # Variáveis de ambiente
├── .env.example         # Exemplo de variáveis de ambiente
├── .gitignore           # Arquivos ignorados pelo git
├── package.json         # Dependências e scripts
├── tsconfig.json        # Configuração do TypeScript (se aplicável)
└── README.md            # Documentação

Licença

MIT

/cli-aspen/

    Package Sidebar

    Install

    npm i cli-aspen

    Weekly Downloads

    2

    Version

    0.1.0

    License

    MIT

    Unpacked Size

    209 kB

    Total Files

    72

    Last publish

    Collaborators

    • mateus.devlp