Command Line Interface
Squirrels provides a command-line interface (CLI) for managing your project. The CLI is accessed through the sqrl
command.
Available Commands
Command | Description |
---|---|
new | Create a new squirrels project |
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 |
Common Options
All commands support the following common options:
Option | Description |
---|---|
--log-level | Level of logging to use (DEBUG, INFO, WARNING). Default is INFO |
--log-format | Format of the log records (text, json). Default is text |
--log-file | Name 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