PlatformCommands

Platform Commands

To startup the platform, specify the config file with -c . To specify a log file, use: -l

bin/volttron-lite -c config.ini -l volttron.log

Full options:

Volttron Lite agent platform daemon

optional arguments:
  -b, --background      background (daemonize) the process
  -c FILE, --config FILE
                        read configuration from FILE
  --gid GID             change group to given GID; only used with -b
  -l FILE, --log FILE   send log output to FILE instead of stderr
  -L FILE, --log-config FILE
                        read logging configuration from FILE
  -p FILE, --pid-file FILE
                        write process ID to FILE; only used with -b
  -q, --quiet           decrease logger verboseness; may be used multiple
                        times
  -s SECTION.NAME=VALUE, --set SECTION.NAME=VALUE
                        specify additional configuration
  --uid UID             change user to given UID; only used with -b
  -v, --verbose         increase logger verboseness; may be used multiple
                        times
  --help                show this help message and exit
  --version             show version information and exit

The platform can accept commands during operation using bin/volttron-ctrl

usage: volttron-ctrl command [options]

Control volttron and perform other related tasks

list of commands:
  disable-agent       prevent agent from starting automatically
  enable-agent        enable agent to start automatically
  help                display help about commands
  install-executable  install agent executable
  list-agents         list agents
  list-executables    list agent executables
  load-agent          install agent launch file
  remove-executable   remove agent executable
  run-agent           run agent(s) defined in config file(s)
  shutdown            stop all agents
  start-agent         start installed agent
  stop-agent          stop running agent
  unload-agent        remove agent launch file

Use <tt>volttron-ctrl -v</tt> to show aliases and global options.