quadkit-cli

The quadkit command line: project scaffolding, generators, a smart runner, and administrative commands for every stage of the application lifecycle. Contributor-based — other packages can register their own commands.

For day-to-day Quadkit developers: scaffold, generate, run, inspect.

Installation

uv add quadkit-cli
# or as a standalone tool:
uv tool install quadkit-cli

Requires Python >= 3.11.

Minimal working example

There is no code to write — the product is the command line:

# Create a new project (template defaults to web-api)
quadkit new project my-api

# Generate application code (list all generators: quadkit gen list)
quadkit gen provider MyProvider
quadkit gen controller Orders

# Serve the application; reload is on by default, pass --no-reload in prod
quadkit run my_app.app:create_app --host 0.0.0.0 --port 8000 --workers 4

Global options: --json for machine-readable output, --quiet, --debug, --no-color, and --config <path> to point at a specific application.yaml.

Command index

Per-distribution guide: quadkit-cli reference.

Optional extras

Verified against the package's pyproject.toml: [dev], [test], [all].

Configuration

The CLI reads application.yaml like any Quadkit application; its own section is cli (fields include default_template, default_database, color, verbose), overridable via QK_CLI__*, e.g. QK_CLI__COLOR=false.

Error handling

Commands report structured failures (use --json for machine-readable envelopes) and non-zero exit codes; --debug surfaces full tracebacks.

Testing

quadkit test runs the project suite; the CLI's own behavior is covered by the public test set the release pipeline executes from the exported tree.

Security

The CLI reads configuration and scaffolds code — it does not serve traffic. As with every distribution, keep the 0.x line pinned and review release notes on upgrade. Report vulnerabilities privately per SECURITY.md.

Stability

Version 0.0.3 in the 0.x series, released in lockstep with the other four distributions; APIs may change between minor versions until 1.0 — pin an exact version (quadkit-cli==0.0.3) or a tight range (>=0.0.3,<0.1.0). Full policy: stability and compatibility.

Issues: https://github.com/dbtinoy-/quadkit/issues