quadkit-cli

Command-line interface for the Quadkit Framework.

Overview

The quadkit CLI provides project scaffolding, code generation, development tooling, and administrative commands for every stage of the application lifecycle. It uses a contributor-based plugin system so other packages can extend the CLI with new commands and generators.

Full documentation: docs.quadkit.dev

Install

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

Quick Start

from quadkit import Application
from quadkit.di.module import Module, module

from quadkit.cli import CLIModule
from quadkit.cli.config import CLIConfig


@module(imports=[CLIModule.configure(CLIConfig())])
class AppModule(Module):
    pass


async with Application.boot(modules=[AppModule]) as app:
    # use app.container to resolve services
    ...

Or use the CLI directly:

# Create a new web API project
quadkit new project my-api --template web-api

# Scaffold a new extension package
quadkit new package my-feature

# Generate a provider (providers and tests are the built-in generators)
quadkit gen provider MyProvider

# Add the database package to an existing project
quadkit add database

# Start the dev server with hot-reload
quadkit dev start

Configuration

Zero-config usage: Call CLIModule.configure() with no arguments to use all defaults.

Option 1 — YAML file

# application.yaml
cli:
  default_template: "web-api"
  default_database: "postgres"
  color: true
  verbose: false

Option 2 — Profiles + Environment Variables (recommended)

export QK_CLI__DEFAULT_TEMPLATE=web-api
export QK_CLI__COLOR=true
export QK_CLI__VERBOSE=false

Option 3 — Python

from quadkit.cli.config import CLIConfig
from quadkit.cli import CLIModule

config = CLIConfig.from_env_profile()
CLIModule.configure(config)

Config reference

Module Factory Methods

Key Features

• Project scaffolding — web-api, api, and full templates
• Package generation — scaffold new quadkit-* extension packages
• Code generators — provider and test generators built in; more generators ship as CLI contributors from ecosystem packages (e.g. controllers via quadkit-web)
• Contributor system — extensible plugin architecture for new commands
• Shell completion — bash, zsh, and fish completion scripts

Testing

from quadkit import Application
from quadkit.cli import CLIModule


async def test_cli_module():
    async with Application.boot(modules=[CLIModule.stub()]) as app:
        # No-op CLI module for tests
        ...

Key Source Files