Guide 22 · Reference

CLI reference

Use the supported development, build, and production commands.

Generated projects intentionally expose only three everyday scripts: dev, build, and start. Ludicord also provides focused inspection commands for debugging and CI.

#Everyday commands

package.jsonjson

1{
2  "scripts": {
3    "dev": "ludicord dev",
4    "build": "ludicord build",
5    "start": "ludicord start"
6  }
7}

Command	Use it when	Output
`npm run dev`	Building locally	Development server, Fast Refresh, route reload, and error panel
`npm run build`	Preparing a release	Verified `.ludicord` production output
`npm run start`	Running the built app	Production Node server for client, API, auth, and WebSockets

start does not compile source. Run build first and deploy the source-independent runtime artifacts your platform needs.

#Development options

Terminalbash

1ludicord dev --port 4100
2ludicord dev --host 127.0.0.1
3ludicord dev --open
4ludicord dev --debug
5ludicord dev --no-hmr

Option	Meaning
`-p, --port <number>`	Override `server.port` and `PORT`.
`-H, --host <host>`	Override `server.host` and `HOST`.
`--open`	Open the local URL after the server is ready.
`--debug`	Print additional development diagnostics.
`--no-hmr`	Disable hot module replacement for isolation testing.

Configuration and environment files are watched. When one changes, Ludicord safely restarts its runtime; ordinary page, embed, API, and WebSocket edits are recompiled without a manual restart.

#Inspect generated routes

Terminalbash

1npx ludicord routes

The route report lists Activity screens, embeds, API handlers, WebSocket handlers, and proxy rules. Run it when a file exists on disk but its URL does not behave as expected.

#Validate React hooks

Terminalbash

1npx ludicord lint

This checks the Activity source for React Hooks rule violations. Keep it in CI even if your editor already runs ESLint because generated examples and less frequently opened files still need validation.

#Inspect bundle size

Terminalbash

1npx ludicord analyze
2npx ludicord analyze --json

Run a production build first. The human report helps during development; --json is useful for CI thresholds or release tooling.

#Print environment information

Terminalbash

1npx ludicord info

The report identifies the Ludicord version, Node version, project root, config file, route counts, and other runtime facts useful in bug reports. Review output before sharing it, even though Ludicord redacts known secrets from diagnostics.

#Clear generated output

Terminalbash

1npx ludicord clean

This removes only the project's .ludicord build and cache. Use it when generated manifests are stale or after switching between incompatible framework versions, then run dev or build again.

#Generator options

Terminalbash

1npx create-ludicord-app@latest my-activity --tailwind --package-manager pnpm

Option	Meaning
`--tailwind` / `--no-tailwind`	Include or skip Tailwind CSS. Interactive creation defaults to yes.
`--package-manager npm	pnpm
`--git`	Initialize a Git repository.
`--no-install`	Generate files without installing dependencies.

#CI baseline

.github/workflows/check.ymlyaml

1- run: npm ci
2- run: npx ludicord lint
3- run: npm run build

Keep the public README focused on dev, build, and start. Link to this page for inspection and maintenance commands so the first-run path stays simple.

Next, bookmark Troubleshooting for the signals to inspect when a command fails.