Command-line interface

Faircamp's command line interface – which is also available when interacting with the desktop application executable through the terminal – provides a command, subcommand and flag-based interface. Here is an overview:

Usage: faircamp [COMMAND]

Commands:
  build    Build a site
  cache    Manage cached assets
  clean    Delete directories created by faircamp
  docs     Open docs in the browser
  debug    Print debug information
  migrate  Migrate a site directory from v1 to v2
  preview  Build and preview a site in the browser
  tree     Experimental: Export or render a site tree
  help     Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

In the desktop edition, passing any argument or command activates CLI mode. Vice versa, passing no argument or command starts the desktop application.

Run faircamp help for the up-to-date information on available commands and arguments.

All commands reveal their subcommands and available arguments through the respective detail help command, for instance: faircamp help build, faircamp help clean or faircamp help tree export