Command line

The quantum command. Every command takes -h / --help. The Guide explains the everyday ones: CLI commands.

Option	Meaning
--version	The installed version.
-h, --help	The commands and their options.

quantum run

Execute a .q file.

Argument	Meaning	Default	Values
file	.q file to execute
--debug	Debug mode
--config	Config file	quantum.config.yaml
--target	UI target (for type="ui" apps): html, textual, or mobile	html	html, textual, mobile
--engine	Game engine backend: pixi (default, HTML5) or godot (Godot 4 project)	pixi	pixi, godot

Specified by: IA-7 · CFG-1 · UI-0 · UI-2 · UI-8

quantum start

Start web server.

Argument	Meaning	Default	Values
--port	Port (overrides config)
--config	Config file	quantum.config.yaml
--debug	Debug mode
--hot-reload	Reload the open pages when a component or static file changes
--hot-reload-port	WebSocket port for --hot-reload (default 35729)

Specified by: ROUTE-1 · CFG-1 · APP-1 · DEV-1 · DEV-4 · TEST-1

quantum stop

Stop running web server.

Specified by: RUN-3

quantum console

Open the application's pages in the terminal.

Argument	Meaning	Default	Values
[path]	Page to open (default: /)	/
--config	Config file	quantum.config.yaml

Specified by: UI-3

quantum check

Check pages, SQL and query fields against the database.

Argument	Meaning	Default	Values
--config	Config file	quantum.config.yaml

Specified by: ROUTE-4 · UI-10 · DEV-3

quantum test

Run the app's *.test.q tests.

Argument	Meaning	Default	Values
[paths]	Test files or folders to search for *.test.q (default: .)	.

Specified by: APP-2 · TEST-1

quantum desktop

Open the application's pages in a desktop window.

Argument	Meaning	Default	Values
[path]	Page to open (default: /)	/
--config	Config file	quantum.config.yaml
--width	Window width (default: 1024)	1024
--height	Window height (default: 720)	720

Specified by: UI-4 · UI-8

quantum admin

Start the Quantum Admin.

Argument	Meaning	Default	Values
--port	Port (default 8090)	8090
--data	Folder for the admin database and settings (default ./.quantum-admin)	.quantum-admin
--root	Folder the project paths are relative to (default: current folder)	.

quantum pkg

Package management commands.

quantum pkg init

Initialize a new package.

Argument	Meaning	Default	Values
[path]	Directory to initialize (default: current directory)	.
-n, --name	Package name (default: directory name)
-d, --description	Package description
-a, --author	Package author
-l, --license	License identifier (default: MIT)	MIT

quantum pkg publish

Create publishable package archive.

Argument	Meaning	Default	Values
[path]	Package directory (default: current directory)	.

quantum pkg install

Install a package.

Argument	Meaning	Default	Values
source	Package source (local path or git URL)
-v, --version	Specific version to install
--no-deps	Skip dependency resolution

quantum pkg remove

Remove an installed package.

Argument	Meaning	Default	Values
name	Package name to remove
-v, --version	Specific version to remove (default: all versions)

quantum pkg list

List installed packages.

quantum pkg search

Search installed packages.

Argument	Meaning	Default	Values
query	Search query

quantum pkg info

Show package details.

Argument	Meaning	Default	Values
name	Package name
-v, --version	Specific version

quantum jobs

Manage scheduled jobs and job queues.

quantum jobs list

List all scheduled jobs.

Argument	Meaning	Default	Values
--status	Filter by status	all	all, active, paused, pending, running, failed
--queue	Filter by queue name
--format	Output format	table	table, json

quantum jobs status

Get detailed job status.

Argument	Meaning	Default	Values
name	Job name
--format	Output format	table	table, json

quantum jobs run

Run a job manually.

Argument	Meaning	Default	Values
name	Job name
--sync	Wait for job to complete
--params	JSON parameters for the job

quantum jobs pause

Pause a scheduled job.

Argument	Meaning	Default	Values
name	Job name

quantum jobs resume

Resume a paused job.

Argument	Meaning	Default	Values
name	Job name

quantum jobs cancel

Cancel a running or pending job.

Argument	Meaning	Default	Values
name	Job name or job ID

quantum jobs history

View job execution history.

Argument	Meaning	Default	Values
[name]	Job name (optional, shows all if not specified)
--limit	Number of entries to show	10
--status		all	all, success, failed
--format	Output format	table	table, json

quantum jobs worker

Start a job worker process.

quantum jobs worker start

Start worker.

Argument	Meaning	Default	Values
--queue	Queue(s) to process (comma-separated)	default
--concurrency	Number of concurrent workers	4
--poll-interval	Poll interval in seconds	1.0

quantum jobs worker stop

Stop worker.

Argument	Meaning	Default	Values
--graceful	Wait for running jobs to complete

quantum jobs queues

Manage job queues.

quantum jobs queues list

List all queues.

Argument	Meaning	Default	Values
--format		table	table, json

quantum jobs queues purge

Purge all jobs from a queue.

Argument	Meaning	Default	Values
name	Queue name
--status		all	all, pending, failed

quantum jobs queues stats

Show queue statistics.

Argument	Meaning	Default	Values
[name]	Queue name (optional)

quantum mq

Message queue operations.

quantum mq queues

Manage message queues.

quantum mq queues list

List all queues.

Argument	Meaning	Default	Values
--format		table	table, json

quantum mq queues create

Create a queue.

Argument	Meaning	Default	Values
name	Queue name
--durable	Durable queue	True
--dlq	Dead letter queue name
--ttl	Message TTL in milliseconds

quantum mq queues delete

Delete a queue.

Argument	Meaning	Default	Values
name	Queue name
--force	Force delete even if not empty

quantum mq queues purge

Purge all messages from a queue.

Argument	Meaning	Default	Values
name	Queue name

quantum mq queues peek

Peek messages without consuming.

Argument	Meaning	Default	Values
name	Queue name
--limit	Number of messages to peek	10
--format		table	table, json

quantum mq topics

Manage topics.

quantum mq topics list

List all topics.

Argument	Meaning	Default	Values
--format		table	table, json

quantum mq publish

Publish a message to a topic.

Argument	Meaning	Default	Values
topic	Topic name
[message]	Message body (JSON string or plain text)
--file	Read message from file
--header	Add header (format: key=value)

quantum mq send

Send a message to a queue.

Argument	Meaning	Default	Values
queue	Queue name
[message]	Message body (JSON string or plain text)
--file	Read message from file
--header	Add header (format: key=value)
--delay	Delay in seconds before delivery

quantum mq consume

Consume messages from a queue.

Argument	Meaning	Default	Values
queue	Queue name
--limit	Number of messages to consume	1
--timeout	Timeout in seconds	5
--ack	Auto-acknowledge messages
--format		json	table, json

quantum mq subscribe

Subscribe to a topic (real-time).

Argument	Meaning	Default	Values
topic	Topic pattern (supports wildcards)
--format		json	raw, json

quantum mq worker

Start a message worker.

Argument	Meaning	Default	Values
--queues	Queues to consume (comma-separated)
--handler	Handler script (.q file)
--concurrency	Number of concurrent consumers	4
--prefetch	Prefetch count	1

quantum mq stats

Show message broker statistics.

Argument	Meaning	Default	Values
--format		table	table, json

quantum mq info

Show connection information.

quantum migrate

Database migration commands.

Argument	Meaning	Default	Values
--datasource	Datasource from quantum.config.yaml (default: the only one declared)

Specified by: DB-6 · DB-7 · DB-10 · CFG-3

quantum migrate status

Show migration status.

quantum migrate up

Apply pending migrations.

Argument	Meaning	Default	Values
-n, --count	Number of migrations to apply

Specified by: DB-7

quantum migrate down

Rollback migrations.

Argument	Meaning	Default	Values
-n, --count	Number of migrations to rollback	1

quantum migrate create

Create a new migration.

Argument	Meaning	Default	Values
name	Migration name

quantum migrate plan

Compare schema.sql with the migrations and plan the migration.

Argument	Meaning	Default	Values
--schema	Schema file (default: schema.sql)	schema.sql
--write	Save the plan as migration V00N_NAME
--yes	Do not ask before writing
--allow-data-loss	Write a plan that drops tables or columns

Specified by: DB-10