Skip to content

Core Commands

kelpmesh init

Scaffold a new KelpMesh project.

kelpmesh init [project_name] [options]

Options: - --encrypt — Initialize with state encryption support

kelpmesh run

Execute models in dependency order.

kelpmesh run [options]

Options: - --select — Model selection expression (+model, model+, @model) - --full-refresh — Re-run all models regardless of state - --threads — Number of parallel threads (default: 4)

kelpmesh test

Run SQL assertion tests.

kelpmesh test [options]

Options: - --warn — Treat test failures as warnings (non-blocking) - --select — Test selection expression

kelpmesh build

Run models then tests in a single command.

kelpmesh build [options]

kelpmesh diff

Compare current model output against the previous run.

kelpmesh diff <model_name>

kelpmesh preview

Preview model data from the warehouse.

kelpmesh preview <model_name> [options]

Options: - --limit — Number of rows to show (default: 100)

kelpmesh docs

Generate static HTML documentation for your project.

kelpmesh docs [options]

Options: - --serve — Serve docs with a local HTTP server - --port — Port for HTTP server (default: 8000)

kelpmesh ls

List models with their status and materialization type.

kelpmesh ls [options]

kelpmesh clean

Remove target/ directory and reset project state.

kelpmesh clean

kelpmesh seed

Load seed SQL data into the warehouse.

kelpmesh seed <seed_file.sql>

KelpMesh schema diff

Detect schema drift by comparing current warehouse schema against stored schema.

KelpMesh schema diff

kelpmesh debug

Show project health summary including encryption status, warehouse connection, and security posture.

kelpmesh debug

KelpMesh pre-commit

Validate SQL files and detect circular dependencies. Designed for CI/pre-commit hooks.

KelpMesh pre-commit [options]

Options: - --project-dir — Project directory (default: current directory)

KelpMesh orchestrate

Multi-project orchestration across repositories.

KelpMesh orchestrate [options]