CLI reference

Complete reference documentation for the Bauplan Command Line Interface (CLI).

Global options

Flag	Short	Default	Description
`--profile <PROFILE>`	`-P`	-	Name of the profile to use
`--output <OUTPUT>`	`-O`	`tty`	Output format
`--client-timeout <CLIENT_TIMEOUT>`	-	-	Timeout (in seconds) for client operations (-1 = no timeout)
`--verbose`	`-v`	-	Print verbose logs

bauplan version

Print version

bauplan version

bauplan info

Print debug information about the current environment

bauplan info

bauplan run

Execute a bauplan run

bauplan run [OPTIONS]

Options

Flag	Short	Default	Description
`--project-dir <PROJECT_DIR>`	`-p`	`.`	Path to the root Bauplan project directory
`--ref <REF>`	`-r`	-	Ref or branch name from which to run the job [default: active branch]
`--namespace <NAMESPACE>`	`-n`	-	Namespace to run the job in. If not set, the job will be run in the default namespace for the project
`--cache <CACHE>`	-	`on`	Set the cache mode
`--preview <PREVIEW>`	-	`off`	Set the preview mode
`--strict <STRICT>`	-	`off`	Exit upon encountering runtime warnings (e.g., invalid column output)
`--transaction <TRANSACTION>`	`-t`	`on`	Run the dag as a transaction. Will create a temporary branch where models are materialized. Once all models succeed, it will be merged to the branch in which this run is happening
`--dry-run`	-	-	Dry run the job without materializing any models
`--param <PARAM>`	-	-	Set a parameter for the job. Format: key=value. Can be used multiple times (repeatable)
`--detach`	`-d`	-	Run the job in the background instead of streaming logs
`--arg <ARG>`	`-a`	-	Extra arguments as key=value pairs (repeatable) (repeatable)
`--priority <PRIORITY>`	-	-	Set the job priority (1-10, where 10 is highest priority)

Examples

# Run pipeline in current directory
bauplan run

# Dry run without materializing models
bauplan run --dry-run

# Run with strict mode and preview
bauplan run --strict on --preview head

# Run on specific branch with parameters
bauplan run --ref main --param env=prod

# Run in background
bauplan run --detach

bauplan branch

Manage branches

bauplan branch <COMMAND> [OPTIONS]

Subcommands

ls - List branches (shows only your branches by default)
create - Create a new branch
rm - Delete a branch
get - Get information about a branch
checkout - Set the active branch
diff - Show the diff between the active branch and another branch
merge - Merge a branch into the active branch
rename - Rename a branch

bauplan branch ls

List branches (shows only your branches by default)

Aliases: list

bauplan branch ls [OPTIONS] [BRANCH_NAME]

Arguments

<BRANCH_NAME> - Branch name

Options

Flag	Short	Default	Description
`--all-zones`	`-a`	-	Show all branches, including those from other namespaces (users)
`--name <NAME>`	`-n`	-	Filter by name
`--user <USER>`	`-u`	-	Filter by user
`--limit <LIMIT>`	-	-	Limit the number of branches to show

Examples

# List user's own branches
bauplan branch ls

# List all branches
bauplan branch ls --all-zones

# Filter by name
bauplan branch ls --name "dev"

# Filter by user
bauplan branch ls --user username

# Limit results
bauplan branch ls --limit 5

bauplan branch create

Create a new branch

bauplan branch create [OPTIONS] <BRANCH_NAME>

Arguments

<BRANCH_NAME> - Branch name

Options

Flag	Short	Default	Description
`--from-ref <FROM_REF>`	-	-	Ref to branch from [default: active branch]
`--if-not-exists`	-	-	Do not fail if the branch already exists

Examples

# Create branch from active branch
bauplan branch create username.dev_branch

# Create branch from specific ref
bauplan branch create username.new_feature --from-ref main

# Create branch if it doesn't already exist
bauplan branch create username.my_branch --if-not-exists

bauplan branch rm

Delete a branch

Aliases: delete

bauplan branch rm [OPTIONS] <BRANCH_NAME>

Arguments

<BRANCH_NAME> - Branch name

Options

Flag	Short	Default	Description
`--if-exists`	-	-	Command succeeds even if the branch does not exist

Examples

# Delete a branch
bauplan branch rm username.old_branch

# Conditionally delete
bauplan branch rm username.maybe_branch --if-exists

bauplan branch get

Get information about a branch

bauplan branch get [OPTIONS] <BRANCH_NAME>

Arguments

<BRANCH_NAME> - Branch name

Options

Flag	Short	Default	Description
`--namespace <NAMESPACE>`	`-n`	-	Filter by namespace (exact match or regex)

Examples

# Get branch information
bauplan branch get username.dev_branch

# Get with namespace filter
bauplan branch get username.branch --namespace raw_data

bauplan branch checkout

Set the active branch

bauplan branch checkout <BRANCH_NAME>

Arguments

<BRANCH_NAME> - Branch name

Examples

bauplan branch checkout main
bauplan branch checkout username.dev_branch

bauplan branch diff

Show the diff between the active branch and another branch

bauplan branch diff [OPTIONS] <BRANCH_NAME_A> [BRANCH_NAME_B]

Arguments

<BRANCH_NAME_A> - Branch name a
<BRANCH_NAME_B> - Branch name b

Options

Flag	Short	Default	Description
`--namespace <NAMESPACE>`	`-n`	-	Filter by namespace (exact match or regex)

Examples

# Diff between active branch and another
bauplan branch diff username.dev_branch

# Diff between two specific branches
bauplan branch diff main username.dev_branch

# Diff with namespace filter
bauplan branch diff username.branch1 username.branch2 --namespace raw_data

bauplan branch merge

Merge a branch into the active branch

bauplan branch merge [OPTIONS] <BRANCH_NAME>

Arguments

<BRANCH_NAME> - Branch name

Options

Flag	Short	Default	Description
`--commit-message <COMMIT_MESSAGE>`	-	-	Optional commit message

Examples

# Merge branch into active branch
bauplan branch merge username.dev_branch

# Merge with custom commit message
bauplan branch merge username.feature --commit-message "Merge feature updates"

bauplan branch rename

Rename a branch

bauplan branch rename <BRANCH_NAME> <NEW_BRANCH_NAME>

Arguments

<BRANCH_NAME> - Branch name
<NEW_BRANCH_NAME> - New branch name

Examples

bauplan branch rename username.old_name username.new_name

bauplan tag

Manage tags

bauplan tag <COMMAND> [OPTIONS]

Subcommands

ls - List all available tags (default action)
create - Create a new tag
rm - Delete a tag
rename - Rename a tag

bauplan tag ls

List all available tags (default action)

Aliases: list

bauplan tag ls [OPTIONS]

Options

Flag	Short	Default	Description
`--name <NAME>`	-	-	Filter by name (can be a regex)
`--limit <LIMIT>`	-	-	Limit the number of tags to show

Examples

# List all tags
bauplan tag ls

# Filter by name pattern
bauplan tag ls --name "v.*"

# Limit results
bauplan tag ls --limit 10

bauplan tag create

Create a new tag

bauplan tag create [OPTIONS] <TAG_NAME>

Arguments

<TAG_NAME> - Tag name

Options

Flag	Short	Default	Description
`--from-ref <FROM_REF>`	-	-	Ref to create the tag from [default: active branch]
`--if-not-exists`	-	-	Do not fail if the tag already exists

Examples

# Create tag from active branch
bauplan tag create v1.0

# Create tag from specific ref
bauplan tag create v1.0 --from-ref main

# Create tag if it doesn't already exist
bauplan tag create v1.0 --if-not-exists

bauplan tag rm

Delete a tag

Aliases: delete

bauplan tag rm [OPTIONS] <TAG_NAME>

Arguments

<TAG_NAME> - Tag name

Options

Flag	Short	Default	Description
`--if-exists`	-	-	Do not fail if the tag does not exist

Examples

# Delete a tag
bauplan tag rm v1.0

# Conditionally delete
bauplan tag rm v1.0 --if-exists

bauplan tag rename

Rename a tag

bauplan tag rename <TAG_NAME> <NEW_TAG_NAME>

Arguments

<TAG_NAME> - Tag name
<NEW_TAG_NAME> - New tag name

Examples

bauplan tag rename v1.0 v1.0-stable

bauplan commit

Show commit history for a ref

bauplan commit [OPTIONS] [REF_NAME]

Arguments

<REF_NAME> - Ref or branch name to get commits from [default: active branch]

Options

Flag	Short	Default	Description
`--message <MESSAGE>`	-	-	Filter by message content (string or a regex like "^something.*$")
`--author-username <AUTHOR_USERNAME>`	-	-	Filter by author username (string or a regex like "^something.*$")
`--author-name <AUTHOR_NAME>`	-	-	Filter by author name (string or a regex like "^something.*$")
`--author-email <AUTHOR_EMAIL>`	-	-	Filter by author email (string or a regex like "^something.*$")
`--property <PROPERTY>`	-	-	Filter by a property. Format: key=value. Can be used multiple times (repeatable)
`--max-count <MAX_COUNT>`	`-n`	`10`	Limit the number of commits to show
`--format <FORMAT>`	-	`medium`	How to format commits

Examples

# Show recent commits on active branch
bauplan commit

# Show commits from specific branch
bauplan commit main

# Show more commits
bauplan commit --max-count 20

# Show commits by specific author
bauplan commit --author-username john_doe

# Show commits matching message pattern
bauplan commit --message "^fix.*" --max-count 5

# Show commits in oneline format
bauplan commit --format oneline

bauplan namespace

Manage namespaces

bauplan namespace <COMMAND> [OPTIONS]

Subcommands

ls - List available namespaces
create - Create a new namespace
rm - Drop a namespace from the data catalog

bauplan namespace ls

List available namespaces

Aliases: list

bauplan namespace ls [OPTIONS] [NAMESPACE]

Arguments

<NAMESPACE> - Filter namespaces by name

Options

Flag	Short	Default	Description
`--ref <REF>`	`-r`	-	Ref or branch name to list namespaces from [default: active branch]
`--limit <LIMIT>`	-	-	Limit the number of namespaces to show

Examples

# List namespaces on active branch
bauplan namespace ls

# List namespaces on specific branch
bauplan namespace ls --ref main

# Limit results
bauplan namespace ls --limit 10

bauplan namespace create

Create a new namespace

bauplan namespace create [OPTIONS] <NAMESPACE>

Arguments

<NAMESPACE> - Namespace

Options

Flag	Short	Default	Description
`--branch <BRANCH>`	`-b`	-	Branch to create the namespace in [default: active branch]
`--if-not-exists`	-	-	Do not fail if the namespace already exists
`--commit-body <COMMIT_BODY>`	-	-	Optional commit body to append to the commit message

Examples

# Create namespace on active branch
bauplan namespace create raw_data

# Create namespace on specific branch
bauplan namespace create transformed_data --branch main

# Create namespace if it doesn't already exist
bauplan namespace create my_namespace --if-not-exists

bauplan namespace rm

Drop a namespace from the data catalog

Aliases: delete, drop

bauplan namespace rm [OPTIONS] <NAMESPACE>

Arguments

<NAMESPACE> - Namespace

Options

Flag	Short	Default	Description
`--branch <BRANCH>`	`-b`	-	Branch to delete the namespace from [default: active branch]
`--if-exists`	-	-	Do not fail if the namespace does not exist
`--commit-body <COMMIT_BODY>`	-	-	Optional commit body to append to the commit message

Examples

# Delete namespace from active branch
bauplan namespace rm old_namespace

# Delete from specific branch
bauplan namespace rm old_namespace --branch main

# Conditionally delete
bauplan namespace rm maybe_namespace --if-exists

bauplan table

Manage tables

bauplan table <COMMAND> [OPTIONS]

Subcommands

ls - List all available tables
get - Get information about a table
rm - Drop a table from the data catalog (does not free up storage)
create - Create a new table
create-plan - Create a plan for a new table
create-plan-apply - Apply a table create plan manually
create-external - Create an external read-only Iceberg table from existing data without any copies
import - Import data to an existing table. Use bauplan table create to create the table first
revert - Revert a table to a previous state from a source ref

bauplan table ls

List all available tables

Aliases: list

bauplan table ls [OPTIONS]

Options

Flag	Short	Default	Description
`--name <NAME>`	-	-	Filter tables by name (exact match or regex)
`--namespace <NAMESPACE>`	`-n`	-	Filter by namespace (exact match or regex)
`--ref <REF>`	`-r`	-	Ref or branch name to list tables from [default: active branch]
`--limit <LIMIT>`	-	-	Limit the number of tables to show

Examples

# List tables on active branch
bauplan table ls

# List tables in specific namespace
bauplan table ls --namespace raw_data

# List tables from specific branch
bauplan table ls --ref main

# Limit results
bauplan table ls --limit 20

bauplan table get

Get information about a table

bauplan table get [OPTIONS] <TABLE_NAME>

Arguments

<TABLE_NAME> - Table name

Options

Flag	Short	Default	Description
`--ref <REF>`	`-r`	-	Ref or branch name to get the table from [default: active branch]

Examples

# Get table info from active branch
bauplan table get customers

# Get table info from specific branch
bauplan table get customers --ref main

# Get table info with namespace prefix
bauplan table get raw_data.customers

bauplan table rm

Drop a table from the data catalog (does not free up storage)

Aliases: delete, drop

bauplan table rm [OPTIONS] <TABLE_NAME>

Arguments

<TABLE_NAME> - Table name

Options

Flag	Short	Default	Description
`--branch <BRANCH>`	`-b`	-	Branch to delete the table from [default: active branch]
`--if-exists`	-	-	Do not fail if the table does not exist
`--commit-body <COMMIT_BODY>`	-	-	Optional commit body to append to the commit message

Examples

# Delete table from active branch
bauplan table rm old_table

# Delete from specific branch
bauplan table rm old_table --branch main

# Conditionally delete
bauplan table rm maybe_table --if-exists

bauplan table create

Create a new table

bauplan table create [OPTIONS] <TABLE_NAME>

Arguments

<TABLE_NAME> - Name of the table to create

Options

Flag	Short	Default	Description
`--branch <BRANCH>`	`-b`	-	Branch to create the table in [default: active branch]
`--namespace <NAMESPACE>`	`-n`	-	Namespace for the table
`--search-uri <SEARCH_URI>`	-	-	S3 URI pattern for parquet files to import (e.g. s3://bucket/path/*)
`--partitioned-by <PARTITIONED_BY>`	-	-	Partition the table by the given columns
`--replace`	`-r`	-	Replace the existing table, if it exists
`--arg <ARG>`	`-a`	-	Extra arguments as key=value pairs (repeatable) (repeatable)
`--priority <PRIORITY>`	-	-	Set the job priority (1-10, where 10 is highest priority)

Examples

# Create table from S3 data
bauplan table create customers --search-uri s3://mybucket/customers/*.parquet --namespace raw_data

# Create table with partitioning
bauplan table create orders --search-uri s3://mybucket/orders/*.parquet --partitioned-by date_column

# Create table on specific branch
bauplan table create products --search-uri s3://mybucket/products/*.parquet --branch main

# Replace existing table
bauplan table create customers --search-uri s3://mybucket/customers/*.parquet --replace

bauplan table create-plan

Create a plan for a new table

bauplan table create-plan [OPTIONS] <TABLE_NAME>

Arguments

<TABLE_NAME> - Name of the table to create

Options

Flag	Short	Default	Description
`--branch <BRANCH>`	`-b`	-	Branch to create the table in [default: active branch]
`--namespace <NAMESPACE>`	`-n`	-	Namespace for the table
`--search-uri <SEARCH_URI>`	-	-	S3 URI pattern for parquet files to import (e.g. s3://bucket/path/*)
`--partitioned-by <PARTITIONED_BY>`	-	-	Partition the table by the given columns
`--replace`	`-r`	-	Replace the existing table, if it exists
`--save-plan <SAVE_PLAN>`	`-p`	-	A filename to write the plan to
`--arg <ARG>`	`-a`	-	Extra arguments as key=value pairs (repeatable) (repeatable)

Examples

# Create plan and save to file
bauplan table create-plan customers --search-uri s3://mybucket/customers/*.parquet --save-plan plan.json

# Create plan without saving
bauplan table create-plan products --search-uri s3://mybucket/products/*.parquet

bauplan table create-plan-apply

Apply a table create plan manually

bauplan table create-plan-apply [OPTIONS]

Options

Flag	Short	Default	Description
`--plan <PLAN>`	-	-	Path to a plan YAML file; reads from stdin if not provided
`--arg <ARG>`	`-a`	-	Extra arguments as key=value pairs (repeatable) (repeatable)
`--priority <PRIORITY>`	-	-	Set the job priority (1-10, where 10 is highest priority)

Examples

# Apply previously created plan
bauplan table create-plan-apply --plan plan.json

bauplan table create-external

Create an external read-only Iceberg table from existing data without any copies

bauplan table create-external [OPTIONS] <TABLE_NAME>

Arguments

<TABLE_NAME> - Name of the external table to create

Options

Flag	Short	Default	Description
`--branch <BRANCH>`	`-b`	-	Branch to create the table in [default: active branch]
`--namespace <NAMESPACE>`	`-n`	-	Namespace for the table
`--metadata-json-uri <METADATA_JSON_URI>`	-	-	URI to Iceberg metadata.json file (e.g., s3://bucket/metadata.json)
`--search-pattern <SEARCH_PATTERN>`	-	-	Search pattern for parquet files (e.g., s3://bucket/2025/*.parquet). Can be specified multiple times (repeatable)
`--overwrite`	-	-	Overwrite the table if it already exists
`--detach`	`-d`	-	Run the job in the background (only for parquet mode)
`--arg <ARG>`	`-a`	-	Extra arguments as key=value pairs, repeatable (only for parquet mode) (repeatable)
`--priority <PRIORITY>`	-	-	Set the job priority (1-10, where 10 is highest priority) (only for parquet mode)

Examples

# Create external table from Iceberg metadata
bauplan table create-external events --metadata-json-uri s3://bucket/metadata.json --namespace raw_data

# Create external table from parquet files
bauplan table create-external events --search-pattern "s3://bucket/data/*.parquet" --namespace raw_data

# Create external table with multiple search patterns
bauplan table create-external events --search-pattern "s3://bucket/2024/*.parquet" --search-pattern "s3://bucket/2025/*.parquet" --namespace raw_data

# Create and overwrite existing table
bauplan table create-external events --search-pattern "s3://bucket/data/*.parquet" --overwrite

bauplan table import

Import data to an existing table. Use bauplan table create to create the table first

bauplan table import [OPTIONS] <TABLE_NAME>

Arguments

<TABLE_NAME> - Name of table where data will be imported into

Options

Flag	Short	Default	Description
`--branch <BRANCH>`	`-b`	-	Branch to import into [default: active branch]
`--namespace <NAMESPACE>`	`-n`	-	Namespace for the table
`--search-uri <SEARCH_URI>`	-	-	Uri search string e.g s3://bucket/path/a/*
`--continue-on-error`	-	-	Don't fail the command even if 1/N files fails to import
`--import-duplicate-files`	-	-	Force importing of files without checking what was already imported. This will likely result in duplicate rows being imported
`--best-effort`	-	-	Set to ignore new columns. if an import file has column aa, bb, and parquet has col aa, bb, cc, columns aa and bb will be imported
`--detach`	`-d`	-	Run the job in the background
`--arg <ARG>`	`-a`	-	Extra arguments as key=value pairs (repeatable) (repeatable)
`--priority <PRIORITY>`	-	-	Set the job priority (1-10, where 10 is highest priority)

Examples

# Import data to existing table
bauplan table import customers --search-uri s3://bucket/customers/new_data/*.parquet

# Import with continue on error flag
bauplan table import events --search-uri s3://bucket/events/*.parquet --continue-on-error

# Import in best-effort mode (ignore new columns)
bauplan table import products --search-uri s3://bucket/products/*.parquet --best-effort

# Import in background
bauplan table import logs --search-uri s3://bucket/logs/*.parquet --detach

bauplan table revert

Revert a table to a previous state from a source ref

bauplan table revert [OPTIONS] <TABLE_NAME>

Arguments

<TABLE_NAME> - Table name

Options

Flag	Short	Default	Description
`--source-ref <SOURCE_REF>`	`-s`	-	The ref (branch or tag) to revert the table from
`--into-branch <INTO_BRANCH>`	`-i`	-	Branch to revert the table into [default: active branch]
`--replace`	-	-	Replace the destination table if it exists
`--commit-body <COMMIT_BODY>`	-	-	Optional commit body to append to the commit message
`--commit-property <COMMIT_PROPERTY>`	-	-	Commit properties as key=value pairs (can be used multiple times) (repeatable)

Examples

# Revert table from another branch
bauplan table revert customers --source-ref main

# Revert table to specific branch
bauplan table revert customers --source-ref main --into-branch username.dev_branch

# Revert and replace if exists
bauplan table revert customers --source-ref v1.0 --replace

# Revert with commit message
bauplan table revert customers --source-ref main --commit-body "Reverted due to data issue"

bauplan query

Run an SQL query

bauplan query [OPTIONS] [SQL]

Arguments

<SQL> - Sql

Options

Flag	Short	Default	Description
`--ref <REF>`	`-r`	-	Ref or branch name to run query against [default: active branch]
`--namespace <NAMESPACE>`	`-n`	-	Namespace to run the query in
`--file <FILE>`	`-f`	-	Read query from file
`--cache <CACHE>`	-	`on`	Set the cache mode
`--max-rows <MAX_ROWS>`	-	`10`	Limit number of returned rows. (use --all-rows to disable this)
`--all-rows`	-	-	Do not limit returned rows. Supersedes --max-rows
`--no-trunc`	-	-	Do not truncate output
`--arg <ARG>`	`-a`	-	Extra arguments as key=value pairs (repeatable) (repeatable)
`--priority <PRIORITY>`	-	-	Set the job priority (1-10, where 10 is highest priority)

Examples

# Run query inline
bauplan query "SELECT * FROM raw_data.customers LIMIT 10"

# Run query from file
bauplan query --file query.sql

# Run query with no row limit
bauplan query --all-rows "SELECT COUNT(*) FROM raw_data.orders"

# Run query on specific branch
bauplan query --ref main "SELECT * FROM my_table"

# Run query in specific namespace
bauplan query --namespace raw_data "SELECT * FROM customers LIMIT 5"

# Run query with full output (no truncation)
bauplan query --no-trunc "SELECT * FROM wide_table"

bauplan parameter

Manage project parameters

bauplan parameter <COMMAND> [OPTIONS]

Subcommands

ls - List all parameters in a project
rm - Remove a parameter from a project
set - Set a parameter value in a project

bauplan parameter ls

List all parameters in a project

Aliases: list

bauplan parameter ls [OPTIONS]

Options

Flag	Short	Default	Description
`--project-dir <PROJECT_DIR>`	`-p`	`.`	Path to the root Bauplan project directory

Examples

# List parameters in current directory
bauplan parameter ls

# List parameters in specific project directory
bauplan parameter ls --project-dir /path/to/project

bauplan parameter rm

Remove a parameter from a project

Aliases: delete

bauplan parameter rm [OPTIONS] <NAME>

Arguments

<NAME> - Name of the parameter to remove

Options

Flag	Short	Default	Description
`--project-dir <PROJECT_DIR>`	`-p`	`.`	Path to the root Bauplan project directory

Examples

# Remove parameter from current project
bauplan parameter rm db_connection

# Remove parameter from specific project
bauplan parameter rm api_key --project-dir /path/to/project

bauplan parameter set

Set a parameter value in a project

bauplan parameter set [OPTIONS] <NAME> [DEFAULT_VALUE]

Arguments

<NAME> - Name
<DEFAULT_VALUE> - A default value

Options

Flag	Short	Default	Description
`--type <TYPE>`	-	-	The type of the parameter
`--description <DESCRIPTION>`	-	-	A description of the parameter
`--required`	-	-	Mark the parameter as required
`--optional`	-	-	Mark the parameter as optional
`--file <FILE>`	`-f`	-	Read value from file
`--project-dir <PROJECT_DIR>`	`-p`	`.`	Path to the root Bauplan project directory

Examples

# Set string parameter
bauplan parameter set env production --type str

# Set integer parameter
bauplan parameter set max_rows 1000 --type int

# Set boolean parameter
bauplan parameter set debug true --type bool

# Set secret parameter
bauplan parameter set api_key mysecretkey --type secret --required

# Set parameter from file
bauplan parameter set config --type str --file config.json

# Set parameter with description
bauplan parameter set db_host localhost --type str --description "Database host"

bauplan config

Configure Bauplan CLI settings

bauplan config <COMMAND> [OPTIONS]

Subcommands

set - Set a configuration value
get - Get the current configuration

bauplan config set

Set a configuration value

bauplan config set <NAME> <VALUE>

Arguments

<NAME> - Setting name
<VALUE> - Value to set

Examples

# Set configuration value
bauplan config set api_key your_key

bauplan config get

Get the current configuration

bauplan config get [OPTIONS]

Options

Flag	Short	Default	Description
`--all`	`-a`	-	Show all the available profiles

Examples

# Show the current profile
bauplan config get

# Show all profiles
bauplan config get --all

bauplan job

Manage jobs

bauplan job <COMMAND> [OPTIONS]

Subcommands

ls - List all available jobs
get - Get information about a job
logs - Get logs for a job
stop - Stop a job

bauplan job ls

List all available jobs

Aliases: list

bauplan job ls [OPTIONS]

Options

Flag	Short	Default	Description
`--all-users`	-	-	Show jobs from all users, not just your own
`--id <ID>`	`-i`	-	Filter by job ID (can be specified multiple times) (repeatable)
`--user <USER>`	`-u`	-	Filter by username (can be specified multiple times) (repeatable)
`--kind <KIND>`	`-k`	-	Filter by job kind (repeatable)
`--status <STATUS>`	`-s`	-	Filter by status (repeatable)
`--created-after <CREATED_AFTER>`	-	-	Filter jobs created after this date (e.g., 2024-01-15 or 2024-01-15T10:30:00Z)
`--created-before <CREATED_BEFORE>`	-	-	Filter jobs created before this date (e.g., 2024-01-15 or 2024-01-15T23:59:59Z)
`--max-count <MAX_COUNT>`	`-n`	`10`	Maximum number of jobs to return (max: 500)
`--utc`	`-z`	-	Use UTC for date parsing and display

Examples

# List recent jobs for current user
bauplan job ls

# List more jobs
bauplan job ls --max-count 20

# List all jobs from all users
bauplan job ls --all-users --max-count 50

# Filter by status
bauplan job ls --status running

# Filter by job kind
bauplan job ls --kind run --kind query

# Filter by specific user
bauplan job ls --user username

# Filter by date range
bauplan job ls --created-after 2024-01-01 --created-before 2024-01-31

# Filter by job ID
bauplan job ls --id abc123 --id def456

# Filter failed jobs
bauplan job ls --status fail --max-count 10

bauplan job get

Get information about a job

bauplan job get <JOB_ID>

Arguments

<JOB_ID> - Job id

Examples

# Get job details
bauplan job get abc123def456

bauplan job logs

Get logs for a job

bauplan job logs [OPTIONS] <JOB_ID>

Arguments

<JOB_ID> - Job id

Options

Flag	Short	Default	Description
`--system`	-	-	Include system logs
`--all`	-	-	Include all logs

Examples

# Get job logs
bauplan job logs abc123def456

# Get all logs including system logs
bauplan job logs abc123def456 --all --system

bauplan job stop

Stop a job

bauplan job stop <JOB_ID>

Arguments

<JOB_ID> - Job id

Examples

# Stop a running job
bauplan job stop abc123def456

bauplan checkout

Set the active branch

bauplan checkout [OPTIONS] <BRANCH_NAME>

Arguments

<BRANCH_NAME> - Branch name

Options

Flag	Short	Default	Description
-	`-b`	-	Create the branch first (equivalent to "branch create --if-not-exists")
`--from-ref <FROM_REF>`	-	-	Ref from which to create when using -b. If not specified, the default is the currently active branch

Examples

# Checkout existing branch
bauplan checkout main

# Checkout user branch
bauplan checkout username.dev_branch

# Create and checkout new branch from main
bauplan checkout -b username.new_feature --from-ref main

# Create and checkout from active branch
bauplan checkout -b username.new_feature

bauplan init

Initialize a new bauplan project

bauplan init [OPTIONS] [PATH]

Arguments

<PATH> - Directory to initialize. Defaults to the current directory

Options

Flag	Short	Default	Description
`--name <NAME>`	-	-	Project name. Defaults to the directory name

Examples

# Initialize a new project in the current directory
bauplan init

# Initialize in a specific directory
bauplan init my_project

# Initialize with a custom project name
bauplan init --name my_pipeline