CLI Cheatsheet
A quick recap of bauplan commands and their intended semantics:
Install and Status
Command / Description |
---|
|
Install the latest version of Bauplan. |
|
Show the version of the Bauplan CLI. |
|
Show a list of available commands or help for one command. |
Git and Explore
Command / Description |
---|
|
Show all the active branches of the user. |
|
Checkout a given branch (switch the active branch ) |
|
Show all the available branches to the user - the active branch marked with a star. |
|
Show all open branches, not only those of the user. |
|
Delete branch (you can only delete your own branches). |
|
Show all the table in a specific branch. |
|
Merge the branch to main. The active branch must be main. |
|
Show all the table in the active branch. |
|
Show table metadata for a specific table in the active branch. |
|
Show the diff between the active branch and a certain branch. |
Run
Command / Description |
---|
|
Execute a Bauplan run from the current folder in the active branch. |
|
Execute a Bauplan run from the current folder and visualize a preview of the tables in the terminal. |
|
Reproduces a previous run identified by its runID. |
|
Execute a Bauplan run while enforcing data contracts. |
Query
Command / Description |
---|
|
Run the query against and display the results. If branch is omitted, default is |
|
Pipe the content of a file, run the query and display the results. If branch is omitted, default is |
Import
Command / Description |
---|
|
Create an import plan file from a cloud storage path that create a new table. Optional: specify a custom output file. |
|
Create an import plan file from a cloud storage path, to replace an existing table. |
|
Create an import plan file from a cloud storage path, to append data to an existing table. |
|
Execute an import job plan file against the given branch. Optional: specify a custom plan input file. |