Skip to main content
Version: 0.5.x

Command Line Interface

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

Available Commands

CommandDescription
newCreate a new squirrels project
get-fileGet a sample file for the squirrels project
depsLoad all packages specified in squirrels.yml
buildBuild the virtual data environment
compileCreate rendered SQL files
runRun the API server
duckdbRun the duckdb command line tool

Common Options

All commands support the following common options:

OptionDescription
--log-levelLevel of logging to use (DEBUG, INFO, WARNING). Default is INFO
--log-formatFormat of the log records (text, json). Default is text
--log-fileName of log file to write to in the "logs/" folder. Default is "squirrels.log"

Getting Help

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

Version

To check the version of squirrels, use:

sqrl -V