Quickstart

Install

uv add quadkit-cli

Or install as a standalone tool:

uv tool install quadkit-cli

Hello World

# Verify the CLI is available
quadkit --help

# Scaffold a new project
quadkit new project my-app --template web-api
cd my-app

# Start the dev server
quadkit dev --reload

Primary Import + Provider Wiring

The CLI can be integrated into a DI container via CLIModule:

from quadkit import Application
from quadkit.cli import CLIModule

app = Application(name="my-app")
app.add_module(CLIModule.configure())

Or using CLIProvider directly:

from quadkit.cli import CLIConfig
from quadkit.cli.di.provider import CLIProvider

provider = CLIProvider(config=CLIConfig())
app.add_provider(provider)

What Just Happened

quadkit new project scaffolded a complete project structure with pyproject.toml, src/, tests/, and application.yaml
quadkit dev auto-detected the create_app() factory and launched an ASGI dev server with hot-reload
CLIModule.configure() registers the CLI provider and exports CLIApplicationProtocol

Next Steps

Guide — full walkthrough of every CLI command
How-Tos — task-oriented recipes