# 🛠️ CLI Reference (v2.4.0) The StaxPilot CLI (`stax`) is a production-grade orchestration engine. Below is the exhaustive list of all 22 available commands and their specialized functions. --- ## Workspace Lifecycle ### `stax init ` **Description:** Bootstraps a new multi-language project. - **Enterprise Features:** Interactive wizard now supports configuring **Social Auth** (Google, GitHub, etc.) and **MFA** at project creation. - **Side Effects:** Creates `.env`, `staxpilot.json`, and populates `workflows/`. ### `stax add ` **Description:** Injects a new module into an active project. - **Smart Wiring:** Automatically detects existing modules and wires the new module's event listeners. - **Provider Choice:** Prompts for provider-specific credentials (e.g., Stripe vs. LemonSqueezy) and updates `.env` instantly. ### `stax remove ` **Description:** Safely de-provisions a module. --- ## Infrastructure & Security ### `stax doctor` **Description:** The ultimate project health diagnostics. - **New Checks:** Now validates **Social Auth Client IDs**, AI provider throughput, and the presence of database backup tools (`pg_dump`). - **Audit:** Ensures all 11 enterprise modules are correctly configured. ### `stax security` **Description:** Scans for production hardening. - **Checks:** JWT secret length, CORS policy, password hashing rounds, and secure header middle-wares. ### `stax cost` **Description:** Generates a cloud cost projection based on your active providers. --- ## 🗄️ Database & AI Operations ### `stax db ` - **`migrate`**: Runs the appropriate migration tool based on language (Prisma for Node, Alembic for Python, GORM for Go). - **`seed`**: Executes seeding logic to populate your development or production database. - **`backup`**: Creates an SQL snapshot of your database. Supports Postgres, MySQL, and SQLite. - **`restore `**: Restores your database from a previously created `.sql` snapshot. ### `stax ai ` - **`test`**: Runs a throughput and latency probe against your configured AI provider (OpenAI, Gemini, etc.). - **`status`**: Displays real-time availability and health status for all supported LLM providers. --- ## Development & Visualization ### `stax dashboard` **Description:** Launches the StaxPilot SaaS Portal locally for real-time event tracing and DB management. ### `stax diagram` **Description:** Generates a Mermaid.js diagram representing your specific module architecture. ### `stax graph` **Description:** Renders a terminal-based visualization of your event-driven module dependencies. --- ## Quality & Registry ### `stax test events` **Description:** Executes Cross-Module Event Flow QA (EFQA). ### `stax publish ` **Description:** Bundles and publishes a custom module to the StaxPilot Registry. ### `stax modules` **Description:** Lists all module templates currently available in the official registry. --- ## Miscellaneous ### `stax config` **Description:** Displays your global StaxPilot CLI settings and authenticated identity. ### `stax frontend ` **Description:** Generates a functional, pre-wired boilerplate frontend for your backend API. ### `stax auth [login|logout|status]` **Description:** Manages your developer session with the StaxPilot registry. ### `stax upgrade` **Description:** Force-refreshes the CLI tool and template cache to the latest production standards. ### `stax help [command]` **Description:** Displays detailed flags and usage instructions for any command or subcommand. ## 🛠️ Module Builder (Local) Build and test your own modular architectures. ### `stax create module ` **Description:** Scaffolds a new module draft in `./stax-modules/` with a commented `module.json` and boilerplate code. ### `stax finalize module ` **Description:** Validates and registers your local module draft into the StaxPilot global cache, making it available for use via `stax add`.