What the CLI is for
The CLI is the shortest path between a clean project and a runnable bot. It handles scaffolding, file generation, development startup, production builds, runtime launch, database integration, and diagnostics through one consistent interface. That consistency matters because the command line is where teams usually lose time to repeated setup steps, naming drift, or half-manual workflows.
In practice, the CLI is most useful when you let each command do one clear job. new creates the workspace, generate adds framework-aligned files, dev runs the active bot, build validates production output, and start runs the compiled artifact. The remaining commands support adjacent workflows such as database setup and environment diagnostics.
Available commands
The CLI ships seven commands. Each one targets a distinct phase of the project lifecycle, from scaffolding a brand-new project to running the compiled artifact in production.
How the commands fit together
Think about the CLI as a lifecycle, not a bag of unrelated commands:
- new creates the initial project shape.
- generate keeps new files aligned with framework conventions.
- dev gives the fastest feedback loop while implementing.
- build is the quality gate before sharing or deploying.
- start runs the exact production artifact you just built.
- database and info support setup and troubleshooting around that loop.
Recommended daily flow
Most teams only touch a subset of the CLI every day. The usual rhythm is to scaffold once, generate as needed, stay in dev during implementation, and use build as the final confidence check before shipping.
Scaffold with new
Run spraxium new once to create the project. Pick your template and optional modules during the interactive wizard.
Generate with generate
Use spraxium generate to add modules, services, listeners, or commands. The CLI places files in the right folder and auto-registers them.
Iterate with dev
Run spraxium dev during implementation. Files reload automatically on save so you see results immediately.
Validate with build
Run spraxium build before every shared environment push. Type errors and bundle failures show up here, not in production.
Ship with start
Run spraxium start in staging and production after a successful build. It reads the compiled output directly.
Local versus CI usage
Local development usually revolves around generate and dev. CI usually cares about build and, in some debugging cases, info --json. Keeping that split clear helps avoid trying to force interactive commands into automation or relying on development-only behavior in production pipelines.
Choosing the right command quickly
If you are unsure which command to run, use this shortcut:
- Need a new project: run spraxium new.
- Need a new framework file: run spraxium generate.
- Need live reload while coding: run spraxium dev.
- Need a deployable artifact: run spraxium build.
- Need to execute the built artifact: run spraxium start.
- Need environment context: run spraxium info.