@donotdev/cli 0.0.3 → 0.0.5

package/templates/root-consumer/guides/CLI.md.example

@@ -1,293 +0,0 @@
-# DoNotDev CLI Guide
-
-**Status:** Up to date with implementation.
-
-**Professional, cross-platform CLI for DoNotDev framework**
-
-## Installation
-
-```bash
-bun install -g @donotdev/cli
-```
-
-## Getting Started
-
-### Initialize a New Project
-
-```bash
-dndev init [project-name]
-```
-
-Creates a new DoNotDev project. If no name is provided, creates in current directory.
-
-```bash
-cd my-project
-bun install
-```
-
-## App Commands
-
-All app commands support smart app detection:
-
-### Development
-
-```bash
-# Launch specific app in development mode
-dndev dev:my-app
-
-# If only one app exists, you can omit the app name
-dndev dev
-
-# If multiple apps exist, you'll be prompted to choose
-dndev dev
-# ? Select app: (Use arrow keys)
-#   > my-app
-#     admin-panel
-#     landing-page
-```
-
-The CLI automatically detects your Vite app and runs the dev server.
-
-### Development with Emulators
-
-```bash
-# Launch app with Firebase emulators
-dndev emu:my-app
-
-# Smart detection works here too
-dndev emu
-```
-
-### Build
-
-```bash
-# Build specific app for production (prompts for frontend/functions/both)
-dndev build:my-app
-
-# Build with explicit type
-dndev build:my-app:front    # Frontend only
-dndev build:my-app:func     # Functions only
-dndev build:my-app:both     # Both frontend and functions
-
-# Smart detection
-dndev build
-```
-
-**Build prompts:**
-
-- If app has both frontend and functions:
-  ```
-  ? What would you like to build?
-    > Frontend only
-      Functions only
-      Both (frontend + functions)
-  ```
-- If app has only frontend or only functions, builds automatically
-
-### Preview
-
-```bash
-# Preview production build (builds if needed)
-dndev preview:my-app
-
-# Smart detection
-dndev preview
-```
-
-### Deploy
-
-```bash
-# Deploy app (asks what to deploy if both frontend and functions exist)
-dndev deploy:my-app
-
-# Smart detection
-dndev deploy
-```
-
-**Deployment prompts:**
-
-- If app has both frontend and functions:
-  ```
-  ? What would you like to deploy?
-    > Frontend only
-      Functions only
-      Both (frontend + functions)
-  ```
-- If app has only frontend or only functions, deploys automatically
-
-## Utility Commands
-
-### Format Code
-
-```bash
-dndev format
-```
-
-Formats code according to framework standards.
-
-### Clean
-
-```bash
-dndev clean
-```
-
-Removes build artifacts, caches, and `node_modules`. Use when troubleshooting build issues, then it'll bun install
-
-### Clear Caches
-
-```bash
-dndev cacheout
-```
-
-Clears build caches (`.turbo`, `.next`, `dist`, .vite, tsconfig.json.buildinfo, ...) without removing `node_modules`. Faster than `clean`.
-Use when you've made many changes to your app to make sure you don't have stale code.
-
-### Lint
-
-```bash
-# Check for linting issues
-dndev lint
-
-# Auto-fix linting issues
-dndev lint:fix
-```
-
-## Smart App Detection
-
-The CLI automatically detects apps in your project:
-
-1. **Single app**: Commands work without specifying app name
-
-   ```bash
-   dndev dev  # Uses the only app automatically
-   ```
-
-2. **Multiple apps**: CLI prompts you to choose
-
-   ```bash
-   dndev dev
-   # ? Select app:
-   #   > my-app
-   #     admin-panel
-   ```
-
-3. **Explicit app name**: Always works
-   ```bash
-   dndev dev:my-app  # Always uses my-app
-   ```
-
-## App Detection Logic
-
-The CLI looks for apps in:
-
-- `apps/*/package.json` (monorepo structure)
-- `package.json` with `name` matching app pattern (single app projects)
-
-For each app, it detects:
-
-- **Framework**: Vite (SPA)
-- **Backend**: Whether functions directory exists
-- **Platform**: Firebase or Vercel (from config files)
-
-## Examples
-
-### Monorepo with Multiple Apps
-
-```bash
-# Project structure:
-# apps/
-#   ├── web/          (Vite app)
-#   ├── admin/        (Vite app)
-#   └── api/          (Functions only)
-
-# Develop web app
-dndev dev:web
-
-# Deploy admin app
-dndev deploy:admin
-# ? What would you like to deploy?
-#   > Frontend only
-#     Functions only
-#     Both
-
-# Build all (if you have a build:all script)
-dndev build
-# ? Select app: web
-```
-
-### Single App Project
-
-```bash
-# Project structure:
-# package.json
-# src/
-# functions/
-
-# All commands work without app name
-dndev dev        # Automatically uses the app
-dndev build      # Automatically uses the app
-dndev deploy     # Automatically uses the app
-```
-
-## Cross-Platform Support
-
-The CLI works seamlessly on:
-
-- ✅ Windows (PowerShell, CMD)
-- ✅ Windows Subsystem for Linux (WSL)
-- ✅ macOS
-- ✅ Linux
-
-All commands use cross-platform path handling and work identically across platforms.
-
-## Error Handling
-
-The CLI provides clear error messages:
-
-```bash
-$ dndev dev:non-existent
-❌ App "non-existent" not found.
-
-Available apps:
-  - my-app
-  - admin-panel
-
-Run 'dndev dev' to select interactively.
-```
-
-## Best Practices
-
-1. **Use smart detection**: Omit app names when working with a single app
-2. **Be explicit in CI/CD**: Always specify app names in scripts
-3. **Use cacheout**: Clear caches before troubleshooting instead of full clean
-4. **Format before commit**: Run `dndev format` before committing code
-
-## Advanced Usage
-
-### Environment Variables
-
-The CLI respects environment variables:
-
-```bash
-# Skip build during deploy
-SKIP_BUILD=true dndev deploy:my-app
-
-# Verbose output
-VERBOSE=true dndev build:my-app
-```
-
-### Custom Scripts
-
-You can still use `package.json` scripts directly:
-
-```bash
-bun run dev:my-app
-bun run build:my-app
-```
-
-But `dndev` commands provide:
-
-- Cross-platform compatibility
-- Smart app detection
-- Consistent interface
-- Better error messages