@launchmatic/cli 0.3.1 → 0.6.0

package/README.md

@@ -0,0 +1,178 @@
+# @launchmatic/cli
+
+Deploy from your terminal. The official CLI for [Launchmatic](https://launchmatic.io) — detect, build, and ship your apps to the cloud in seconds.
+
+## Install
+
+```bash
+npm install -g @launchmatic/cli
+```
+
+## Quick Start
+
+```bash
+lm login                # Authenticate with GitHub
+lm quicklaunch          # Detect, configure, and deploy — one command
+```
+
+Or use **Lightspeed** to create an app from a prompt:
+
+```bash
+c -c a real-time chat app with rooms
+```
+
+## Commands
+
+### Core
+
+| Command | Alias | Description |
+|---------|-------|-------------|
+| `lm login` | | Authenticate via GitHub OAuth |
+| `lm init` | | Initialize a project in the current directory |
+| `lm deploy` | | Build and deploy the current service |
+| `lm quicklaunch` | `lm ql` | Detect, configure, and deploy in one shot |
+| `lm status` | | Show service status, URL, and last deployment |
+| `lm logs` | | Stream live deployment logs |
+| `lm destroy` | | Tear down a service (requires confirmation) |
+
+### AI / Lightspeed
+
+| Command | Description |
+|---------|-------------|
+| `c -c <prompt>` | Create a new app from a natural language description |
+| `c <prompt>` | Modify an existing service with AI |
+| `lm lightspeed` | Same as `c`, integrated into the main CLI |
+
+### Environment & Domains
+
+| Command | Description |
+|---------|-------------|
+| `lm env set KEY=VALUE ...` | Set environment variables |
+| `lm env list` | List environment variables |
+| `lm domains add <hostname>` | Add a custom domain (shows DNS config) |
+
+### Deployments
+
+| Command | Alias | Description |
+|---------|-------|-------------|
+| `lm deployments list` | `lm deploys ls` | View deployment history |
+| `lm deployments info <id>` | | Deployment details |
+| `lm deployments cancel <id>` | | Cancel a running deployment |
+| `lm deployments rollback <id>` | | Roll back to a previous deployment |
+
+### Preview Environments
+
+| Command | Description |
+|---------|-------------|
+| `lm preview list` | List active preview environments |
+| `lm preview create <branch>` | Create a preview deployment for a branch |
+| `lm preview delete <id>` | Delete a preview environment |
+
+### Database
+
+| Command | Alias | Description |
+|---------|-------|-------------|
+| `lm db create` | | Provision a new database |
+| `lm db list` | `lm db ls` | List databases |
+| `lm db connect` | `lm db url` | Get connection string |
+| `lm db query <sql>` | `lm db q` | Run a SQL query |
+| `lm db shell` | `lm db sh` | Interactive SQL shell |
+| `lm db tables` | | List tables |
+| `lm db dump` | | Export database dump |
+| `lm db seed` | | Seed database |
+| `lm db credentials` | `lm db creds` | Show database credentials |
+| `lm db link` | | Link a database to a service |
+| `lm db delete` | `lm db rm` | Delete a database |
+
+Supports PostgreSQL, Redis, and MongoDB via `--engine`.
+
+### GitHub Repo
+
+| Command | Alias | Description |
+|---------|-------|-------------|
+| `lm repo view` | `lm repo v` | Show repo info |
+| `lm repo prs` | | List pull requests |
+| `lm repo issues` | | List issues |
+| `lm repo issue-create` | `lm repo ic` | Create an issue |
+| `lm repo branches` | `lm repo br` | List branches |
+| `lm repo commits` | `lm repo log` | Show commit history |
+| `lm repo releases` | `lm repo rl` | List releases |
+| `lm repo actions` | `lm repo runs` | View GitHub Actions runs |
+| `lm repo browse` | `lm repo web` | Open repo in browser |
+| `lm repo clone` | | Clone the repo |
+| `lm repo diff` | | Show diff |
+| `lm repo stash` | | Stash changes |
+
+### Infrastructure
+
+| Command | Description |
+|---------|-------------|
+| `lm infra list -t <team>` | List pods with CPU, memory, and readiness |
+| `lm infra logs <pod>` | Stream pod logs |
+| `lm infra describe <pod>` | Describe a pod |
+| `lm infra restart <pod>` | Restart a pod |
+| `lm infra delete <pod>` | Delete a pod |
+
+### Browser Automation
+
+| Command | Alias | Description |
+|---------|-------|-------------|
+| `lm browser screenshot [url]` | `lm b ss` | Take a screenshot |
+| `lm browser pdf [url]` | | Generate a PDF |
+| `lm browser open [url]` | | Open in headed browser |
+| `lm browser test [url]` | | Run smoke tests (links, console, a11y) |
+| `lm browser wait [url]` | | Wait for a page to be reachable |
+| `lm browser codegen [url]` | | Record and generate test code |
+| `lm browser devices` | | List available device profiles |
+
+### Utilities
+
+| Command | Description |
+|---------|-------------|
+| `lm doctor` | Scan project for deployment issues and fixes |
+| `lm usage summary` | View CPU, memory, network, and replica stats |
+| `lm usage history` | Resource usage over time (default 24h) |
+| `lm api-key list` | List API keys |
+| `lm api-key create <name>` | Create an API key |
+| `lm api-key delete <id>` | Delete an API key |
+
+## Examples
+
+```bash
+# Deploy a project from the current directory
+lm init
+lm deploy
+
+# One-command deploy with auto-detection
+lm quicklaunch
+
+# Create an app with AI
+c -c a markdown blog with syntax highlighting
+
+# Modify an existing app
+c add a dark mode toggle to the settings page
+
+# Check project health before deploying
+lm doctor
+
+# Manage environment variables
+lm env set DATABASE_URL=postgres://... REDIS_URL=redis://...
+
+# Stream logs
+lm logs
+
+# Roll back a bad deployment
+lm deployments rollback <deployment-id>
+
+# Interactive database shell
+lm db shell
+```
+
+## Requirements
+
+- Node.js >= 20
+- A [Launchmatic](https://launchmatic.io) account
+
+## License
+
+MIT