Overview - Squirrels Docs

Squirrels provides a command-line interface (CLI) for managing, testing, and running your project. The CLI is accessed through the sqrl command.

Usage format

sqrl [command] [positional-arguments] [options]

Command	Description
new	Create a new squirrels project
init	Create a new squirrels project in the current directory
get-file	Get a sample file for the squirrels project
deps	Load all packages specified in squirrels.yml
build	Build the virtual data environment
compile	Create rendered SQL files
run	Run the API server
duckdb	Run the duckdb command line tool

All commands support the following common options:

Option	Description
`-h` or `--help`	Show help message of the command and exit
`--log-level {DEBUG,INFO,WARNING}`	Level of logging to use. Default is from SQRL_LOGGING__LEVEL environment variable or INFO.
`--log-format {text,json}`	Format of the log records. Default is from SQRL_LOGGING__FORMAT environment variable or text.
`--log-to-file`	Enable logging to file(s) in the “logs/” folder (or a custom folder) with rotation and retention policies. Default is false unless overridden by the SQRL_LOGGING__TO_FILE environment variable.

To see help for any command, use the -h or --help option:

sqrl -h  # Show general help
sqrl <command> -h  # Show help for specific command

To check the version of squirrels, use sqrl --version or sqrl -V:

sqrl --version