Other Information / Nut (command line utility)

Note: You are currently reading the documentation for Bolt 2.2. Looking for the documentation for Bolt 5.2 instead?

Bolt comes with a small command line utility, named nut, that can be found in the app/-folder. If you are familiar with working on the commandline, you can some tasks like 'clearing the cache' or 'updating the database' without having to use the webinterface of Bolt. This utility is completely optional, so if you don't have access to the command line on your server, you're not missing out on any essential functionality. It's merely a convenient tool for those that do prefer the command line.

Right now, there are a few basic commands, but we're going to add more and more over time.

When running php app/nut without any parameters, you'll see the help screen:

Console Tool

Usage:
  [options] command [arguments]

Options:
  --help           -h Display this help message.
  --quiet          -q Do not output any message.
  --verbose        -v Increase verbosity of messages.
  --version        -V Display this application version.
  --ansi              Force ANSI output.
  --no-ansi           Disable ANSI output.
  --no-interaction -n Do not ask any interactive question.

Available commands:
  _completion          BASH completion hook.
  cron                 Cron virtual daemon
  extensions           Lists all installed extensions
  help                 Displays help for a command
  info                 Display phpinfo().
  list                 Lists commands
 cache
  cache:clear          Clear the cache
 config
  config:get           Get a value from config.yml.
  config:set           Set a value in config.yml.
 database
  database:check       Check the database for missing tables and/or columns.
  database:export      [EXPERIMENTAL] Export the database records to a YAML or JSON file.
  database:import      [EXPERIMENTAL] Import database records from a YAML or JSON file
  database:prefill     Pre-fill the database Lorem Ipsum records
  database:update      Repair and/or update the database.
 extensions
  extensions:disable   Uninstalls an extension.
  extensions:enable    Installs an extension by name and version.
  extensions:install   Installs an extension by name and version.
  extensions:uninstall Uninstalls an extension.
 log
  log:clear            Clear (truncate) the system & change logs.
  log:trim             Trim the system & change logs.
 role
  role:add             Add a certain role to a user.
  role:remove          Remove a certain role from a user.
 tests
  tests:run            Runs all available tests
 user
  user:add             Add a new user.
  user:reset-password  Reset a user password.

Run any of these commands, to perform their actions, like php app/nut cache:clear.