Nut command / Introduction

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

Bolt provides a powerful command line tool, based on the Symfony Console component.

Note: The nut command is merely a convenient tool for those that do prefer the command line. Its use is not required for normal use.

Nut is usualy located at {site root}/app/nut, and can be executed using your PHP binary, for example to execute the cache:clear Nut command:

$ php ./app/nut cache:clear

Cache cleared!

If you are familiar with working on the command line, you can perform tasks like 'clearing the cache' or 'updating the database' without having to use Bolt's web interface.

Basics¶

The command¶

Typing out a Nut command is best done following this pattern:

$ php ./app/nut command [options] [arguments]

Options and Arguments¶

Values passed to either can be required, a single value, or several values separated by a space character.

Options are the parameters that are suffixed with --, e.g. --help. Unlike argument, options can also not contain a user supplied value.

Some example of how an example:command command line would be built to be executed by Nut:

$ php ./app/nut example:command --option-without-value
$ php ./app/nut example:command SingleArgumentValue
$ php ./app/nut example:command --option-without-value SingleArgumentValue
$ php ./app/nut example:command --send-report true
$ php ./app/nut example:command --pets cats dogs --option-without-value
$ php ./app/nut example:command --pets cats dogs FirstArgumentValue SecondArgumentValue

Default options

Nut commands all have the following set of options that you can add to your command line:

  -h, --help            Display this help message
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

The --help option will give contextual help text, and is the most useful for learning, or refreshing you memory on, command use.

For example, to see Nut's base help:

$ php ./app/nut --help

Alternatively, to get the help text for the cache:clear Nut command:

$ php ./app/nut cache:clear --help

Note: If for any reason Nut generates an exception when running, you can re-run the command with the -vvv option to generate a backtrace to assist in finding the root cause of the problem.

Available commands¶

To see a list of available commands for a given Bolt installation, simply run Nut without any parameters:

$ php app/nut

Current List¶

  _completion               BASH completion hook.
  cron                      Cron virtual daemon
  extensions                Lists all installed extensions
  help                      Displays help for a command
  info                      Display phpinfo().
  init                      Greet the user (and perform initial setup tasks).
  list                      Lists commands
 cache
  cache:clear               Clear the cache
 config
  config:get                Get a value from a config file
  config:set                Set a value in a config file
 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.
 debug
  debug:events              Dumps event listeners.
  debug:providers           Dumps service providers and their order.
  debug:router              System route debug dumper.
  debug:service-providers   Dumps service providers and their order.
  debug:twig                Shows a list of twig functions, filters, globals and tests
 extensions
  extensions:disable        Uninstalls an extension.
  extensions:dump-autoload  Update the extensions autoloader.
  extensions:dumpautoload   Update the extensions autoloader.
  extensions:enable         Installs an extension by name and version.
  extensions:install        Installs an extension by name and version.
  extensions:setup          Set up extension directories, and create/update composer.json.
  extensions:uninstall      Uninstalls an extension.
  extensions:update         Updates extension(s).
 lint
  lint:twig                 Lints a template and outputs encountered errors
 log
  log:clear                 Clear (truncate) the system & change logs.
  log:trim                  Trim the system & change logs.
 pimple
  pimple:dump               Pimple container dumper for PhpStorm & IntelliJ IDEA.
 role
  role:add                  Add a certain role to a user.
  role:remove               Remove a certain role from a user.
 router
  router:match              Helps debug routes by simulating a URI path match
 server
  server:run                Runs PHP built-in web server
 setup
  setup:sync                Synchronise a Bolt install private asset directories with the web root.
 tests
  tests:run                 Runs all available tests
 twig
  twig:lint                 Lints a template and outputs encountered errors
 user
  user:add                  Add a new user.
  user:manage               Manage a user.
  user:reset-password       Reset a user password.

Adding your own Nut command¶

Bolt enables you to extend Nut, and add your own command, via a Bolt extension, see the Nut Console Commands section of the extension documentation for more information.