@nimbuslab/cli 1.0.0 → 1.2.0

package/README.md

@@ -1,109 +1,228 @@
 # @nimbuslab/cli
 
-CLI para criar projetos com a stack moderna da nimbuslab.
+> Modern Next.js project generator with AI-friendly documentation and best practices built-in.
 
-## Instalacao
+Create production-ready Next.js projects in seconds with intelligent setup, optimized documentation for AI coding assistants, and interactive service configuration.
 
-```bash
-npm install -g @nimbuslab/cli
-```
+## Features
+
+✨ **Modern Stack** - Next.js 16, React 19, TypeScript, Tailwind CSS 4, shadcn/ui
+🤖 **AI-Friendly Documentation** - Auto-generated context files for Claude Code, Cursor, GitHub Copilot
+⚡ **Interactive Setup** - Configure services (email, analytics) during project creation
+📦 **Zero Config** - Smart defaults, production-ready from day one
+🎨 **Beautiful UI** - shadcn/ui components with dark mode support
 
-## Comandos
+## Quick Start
 
 ```bash
-nimbus create       # Criar novo projeto (interativo)
-nimbus analyze      # Analisar stack do projeto atual
-nimbus upgrade      # Planejar upgrades de dependencias
-nimbus update       # Atualizar o CLI
-nimbus setup node   # Configurar ambiente Node.js (Volta)
-nimbus help         # Ajuda
+npm install -g @nimbuslab/cli
+nimbus create my-project
 ```
 
 ## Templates
 
 ### Landing Page
 
+Perfect for marketing sites, product launches, and portfolios.
+
 ```bash
-nimbus create meu-site --landing
+nimbus create my-site --landing
 ```
 
-Stack: Next.js 16 + React 19 + Tailwind CSS 4 + shadcn/ui
+**Includes:**
+- Next.js 16 (App Router, Turbopack)
+- React 19 (Server Components)
+- Tailwind CSS 4 (CSS-first)
+- shadcn/ui (default style)
+- TypeScript (strict mode)
+- Responsive design
+- Dark mode support
+- SEO optimized
+
+### Web Application
 
-### Web App
+Full-stack app with authentication and database.
 
 ```bash
-nimbus create meu-app --app
+nimbus create my-app --app
 ```
 
-Stack: Landing + Better Auth + Drizzle ORM + Docker
+**Everything in Landing, plus:**
+- Better Auth (authentication)
+- Drizzle ORM (database)
+- Protected routes
+- User management
+- Dashboard layout
+- Docker support
 
 ### Monorepo
 
+Turborepo setup for multi-app projects.
+
 ```bash
-nimbus create meu-projeto --turborepo
+nimbus create my-workspace --turborepo
 ```
 
-Stack: Turborepo + apps/packages compartilhados
+**Includes:**
+- Turborepo (build system)
+- Shared packages (ui, config, utils)
+- Multiple apps support
+- Optimized caching
+- Parallel execution
+
+## AI-Friendly Documentation
+
+Every project includes automatically generated documentation optimized for LLMs:
+
+### Generated Files
+
+- **AGENTS.md** - Universal context for Claude Code, Cursor, GitHub Copilot
+- **llms.txt** - 2026 standard for LLM indexing (ChatGPT, Perplexity)
+- **ARCHITECTURE.md** - Architectural decisions with rationale
+- **EXAMPLES.md** - Common tasks with complete code examples
+- **Compatibility symlinks** - `.cursorrules`, `.github/copilot-instructions.md`
+
+### Interactive Service Setup
 
-## Setup Node (Volta)
+Configure integrations during project creation:
 
-O comando `nimbus setup node` configura o ambiente Node.js usando [Volta](https://volta.sh).
+- **Resend** - Transactional email (3,000 emails/month free)
+- **Google Analytics** - Site metrics (free)
 
-**Por que Volta?**
-- fnm e nvm causam problemas de cache do shell
-- Volta nao tem esse problema (binarios nativos)
-- Funciona igual no Linux e Windows
-- Gerencia Node, npm e pacotes globais automaticamente
+The CLI provides:
+- Pricing information and signup links
+- API key validation
+- Automatic `.env` and `.env.example` generation
+- Direct links to documentation
+
+Based on [GEO (Generative Engine Optimization)](https://gitbook.com/docs/guides/seo-and-llm-optimization/geo-guide) best practices.
+
+## Commands
 
 ```bash
-# Verificar ambiente atual
-nimbus setup node --check
+nimbus create [name]    # Create new project (interactive)
+nimbus analyze [dir]    # Analyze existing project stack
+nimbus upgrade [target] # Plan dependency upgrades
+nimbus update           # Update CLI itself
+nimbus setup node       # Configure Node.js environment (Volta)
+nimbus help             # Show help
+```
 
-# Migrar para Volta (interativo)
-nimbus setup node
+## Options
+
+| Flag | Description |
+|------|-------------|
+| `-y, --yes` | Accept defaults (skip prompts) |
+| `--no-git` | Skip Git initialization |
+| `--no-install` | Skip dependency installation |
+| `--landing` | Use landing page template |
+| `--app` | Use web app template |
+| `--turborepo` | Use monorepo template |
+
+## Examples
+
+### Landing Page (Auto Mode)
+
+```bash
+nimbus create portfolio --landing -y
+cd portfolio
+bun dev
 ```
 
-O comando:
-1. Detecta fnm/nvm instalados
-2. Remove automaticamente
-3. Instala Volta
-4. Reinstala pacotes globais
+### Web App (Interactive)
 
-## Analyze e Upgrade
+```bash
+nimbus create dashboard --app
+# Follow prompts for service configuration
+cd dashboard
+bun setup  # Database setup
+bun dev
+```
+
+### Analyze Existing Project
+
+```bash
+nimbus analyze ./my-project
+nimbus analyze --json  # JSON output
+```
+
+### Plan Upgrades
 
 ```bash
-# Analisar projeto existente
-nimbus analyze ./meu-projeto
-nimbus analyze --json
-
-# Planejar upgrades
-nimbus upgrade --plan
-nimbus upgrade tailwind
-nimbus upgrade next
+nimbus upgrade --plan        # Show available upgrades
+nimbus upgrade tailwind      # Upgrade specific package
+nimbus upgrade next          # Upgrade Next.js
 ```
 
-## Opcoes
+## Node.js Setup (Volta)
+
+Configure Node.js environment using [Volta](https://volta.sh).
+
+**Why Volta?**
+- No shell cache issues (unlike fnm/nvm)
+- Native binaries for better performance
+- Cross-platform (Linux, macOS, Windows)
+- Automatic version management per project
+
+```bash
+# Check current environment
+nimbus setup node --check
+
+# Migrate to Volta (interactive)
+nimbus setup node
+```
 
-| Flag | Descricao |
-|------|-----------|
-| `-y, --yes` | Aceitar padroes |
-| `--no-git` | Nao inicializar Git |
-| `--no-install` | Nao instalar dependencias |
+The command will:
+1. Detect existing fnm/nvm installations
+2. Remove them automatically
+3. Install Volta
+4. Reinstall global packages
 
-## Requisitos
+## Requirements
 
 - [Bun](https://bun.sh) >= 1.0
 
 ```bash
+# Linux/macOS
 curl -fsSL https://bun.sh/install | bash
+
+# Windows
+powershell -c "irm bun.sh/install.ps1 | iex"
 ```
 
-## Templates Open Source
+## Open Source Templates
+
+- [create-next-landing](https://github.com/nimbuslab/create-next-landing) - Landing page template
+- [create-next-app](https://github.com/nimbuslab/create-next-app) - Web app template
+- [create-turborepo](https://github.com/nimbuslab/create-turborepo) - Monorepo template
+
+## Why nimbuslab CLI?
+
+**Modern Stack**
+Built with the latest technologies: Next.js 16, React 19, Tailwind CSS 4. Always up-to-date.
+
+**AI-First**
+Documentation designed for AI coding assistants. Get better suggestions, faster onboarding.
+
+**Zero Config**
+Smart defaults based on industry best practices. Production-ready from day one.
+
+**Interactive**
+Guided setup for services and integrations. No more reading docs to get started.
+
+**Open Source**
+All templates are open source. Fork, customize, contribute back.
+
+## Support
+
+- 📖 [Documentation](https://github.com/nimbuslab/nimbus-cli)
+- 🐛 [Issues](https://github.com/nimbuslab/nimbus-cli/issues)
+- 💬 [Discussions](https://github.com/nimbuslab/nimbus-cli/discussions)
+
+## License
 
-- [create-next-landing](https://github.com/nimbuslab/create-next-landing)
-- [create-next-app](https://github.com/nimbuslab/create-next-app)
-- [create-turborepo](https://github.com/nimbuslab/create-turborepo)
+MIT © [nimbuslab](https://nimbuslab.com.br)
 
-## Licenca
+---
 
-UNLICENSED - [nimbuslab](https://nimbuslab.com.br) 2026
+**Created by nimbuslab** - Building digital products with design and technology.