CLI Reference

LakeXpress works in two steps:

1. Create a sync configuration with config create. It is stored in the LakeXpress DB.
2. Run it with sync, as often as needed.

The other commands manage the LakeXpress DB (lxdb), show run status (status) and remove stale runs (cleanup).

This section describes the syntax and options of each command. For complete, ready-to-run commands, see Examples & Recipes.

Commands

Command	Purpose
lxdb init, drop, truncate, locks, release-locks	Manage the LakeXpress DB
config create, list, delete	Manage sync configurations
sync, sync[export], sync[publish]	Run a sync configuration
status	Show syncs and runs
cleanup	Remove stale or failed runs
run	Run a legacy YAML configuration

Command Line Structure

usage: LakeXpress [-h] [--version] [--no_banner]
                  COMMAND [SUBCOMMAND] [OPTIONS]

-h, --version and --no_banner can be placed before the command. All other options go after the command, for example LakeXpress sync --log_level DEBUG ....

Common Options

Every command accepts these options. The pages of each command list only its own options.

Option	Description
-a, --auth_file PATH	Credentials JSON file. Required by every command except run
--lxdb_auth_id ID	Entry of the credentials file for the LakeXpress DB. Required by every command except run
--log_level LEVEL	DEBUG, INFO (default), WARNING or ERROR
--log_dir PATH	Directory for log files (default: current directory). See Logging
--no_progress	Disable the progress bar
--no_banner	Do not print the startup banner
--quiet_fbcp	Do not copy FastBCP log lines into the LakeXpress logs (statistics are still recorded)
--license TEXT	License text (alternative to the LAKEXPRESS_LICENSE environment variable)
--license_file PATH	Path to a license file
-h, --help	Show the help of the command and exit

LakeXpress --version shows the version and the date the binary was built.

License Resolution

LakeXpress looks for a license in this order:

1. LAKEXPRESS_LICENSE environment variable
2. --license
3. --license_file
4. Default file locations:
   • Linux/Mac: ~/.lakexpress/license.lic
   • Windows: %APPDATA%/LakeXpress/license.lic
   • Current directory: ./license.lic
5. Trial mode: 30 days from the build date of the binary (shown by --version)