CLI Reference

The bak executable is the primary interface for Bakend projects.

Commands

CommandDescriptionStatus
bak init [name]Create a new Bakend projectImplemented
bak start [--config <path>] [--watch]Start the Bakend serverImplemented
bak dev [--config <path>]Start with function hot reloadImplemented
bak versionPrint Bakend versionImplemented
bak functions listList registered function triggersImplemented
bak jobs listList registered jobsImplemented
bak jobs runs <name>Show recent runs for a jobImplemented
bak migrate statusDiff collections/*.json vs databaseImplemented
bak migrate applyApply collection JSON files to databaseImplemented
bak migrate exportExport database schemas to JSON filesImplemented
bak backup create [--output <path>]Backup database and storageImplemented
bak backup restore <archive> [--force]Restore from backup archiveImplemented
bak storage pruneRemove orphan files not referenced by recordsImplemented

Examples

bak init myapp
cd myapp
bak start
bak migrate status
bak migrate apply
bak migrate export
bak backup create --output ./backups/latest.tar.gz
bak functions list
bak jobs list
bak jobs runs heartbeat

Production Binary

bak version
bak start --config bakend.json

See docs/user-guide/deployment.md for VPS, Docker, and systemd setup.

Configuration

Default config file: bakend.json beside your project data.

Paths in config are resolved relative to the config file directory.

Log levels: DEBUG, INFO, WARN, ERROR