CLI Reference¶

Complete reference for all weevr commands and flags.

Global flags available on every command:

--json — output in JSON format for machine consumption
--version / -v — show version and exit

weevr¶

CLI for managing weevr projects — scaffolding, validation, and deployment.

Usage:

weevr [OPTIONS] COMMAND [ARGS]...

Options:

  --json                Output in JSON format for machine consumption.
  -v, --version         Show version and exit.
  --install-completion  Install completion for the current shell.
  --show-completion     Show completion for the current shell, to copy it or
                        customize the installation.
  --help                Show this message and exit.

deploy¶

Deploy project files to a Fabric Lakehouse.

Usage:

weevr deploy [OPTIONS] [PATHS]...

Options:

  [PATHS]...             Specific files to deploy.
  -t, --target TEXT      Named deploy target.
  --workspace-id TEXT    Override workspace.
  --lakehouse-id TEXT    Override lakehouse GUID.
  --lakehouse-name TEXT  Override lakehouse friendly name (mutually exclusive
                         with --lakehouse-id).
  --path-prefix TEXT     Override path prefix.
  --full                 Full overwrite instead of smart sync.
  --clean                Remove remote files not present locally.
  --all                  With --clean, remove all remote files.
  --dry-run              Show what would change.
  --skip-validation      Skip pre-deploy validation.
  --strict-validation    Block deploy on validation warnings.
  --force                Skip confirmation prompts.
  --help                 Show this message and exit.

init¶

Create a new weevr project.

Usage:

weevr init [OPTIONS] [NAME]

Options:

  [NAME]             Project name or directory.  [default: .]
  --examples         Include example files.
  -i, --interactive  Interactive wizard.
  --help             Show this message and exit.

list¶

Display project structure and dependency relationships.

Usage:

weevr list [OPTIONS]

Options:

  -f, --format TEXT  Output format: tree or table.  [default: tree]
  --help             Show this message and exit.

new¶

Generate a new thread, weave, loom, or warp file from a template.

Usage:

weevr new [OPTIONS] FILE_TYPE NAME

Options:

  FILE_TYPE  File type: thread, weave, loom, or warp.  [required]
  NAME       Name for the new file.  [required]
  --force    Overwrite existing file.
  --help     Show this message and exit.

plugins¶

Manage CLI plugins.

Usage:

weevr plugins [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

info¶

Show detailed information about a specific plugin.

Usage:

weevr plugins info [OPTIONS] NAME

Options:

  NAME    Plugin name.  [required]
  --help  Show this message and exit.

list¶

List all discovered plugins and their status.

Usage:

weevr plugins list [OPTIONS]

Options:

  --help  Show this message and exit.

schema¶

Manage validation schemas.

Usage:

weevr schema [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

update¶

Fetch latest schemas from GitHub to .weevr/schemas/.

Usage:

weevr schema update [OPTIONS]

Options:

  --version TEXT  Specific schema version (git tag/branch).
  --help          Show this message and exit.

version¶

Show the active schema version and source.

Usage:

weevr schema version [OPTIONS]

Options:

  --help  Show this message and exit.

status¶

Show diff between local files and deployed state.

Usage:

weevr status [OPTIONS]

Options:

  -t, --target TEXT      Named deploy target.
  --workspace-id TEXT    Override workspace.
  --lakehouse-id TEXT    Override lakehouse GUID.
  --lakehouse-name TEXT  Override lakehouse friendly name (mutually exclusive
                         with --lakehouse-id).
  --path-prefix TEXT     Override path prefix.
  --exit-code            Exit 1 if differences exist.
  --verbose              Show all files including non-weevr.
  --help                 Show this message and exit.

validate¶

Validate project files against schemas and check reference integrity.

Usage:

weevr validate [OPTIONS] [PATH]

Options:

  [PATH]    File or directory to validate.
  --strict  Treat warnings as errors.
  --help    Show this message and exit.