commands.rst

Command Line Interface (CLI)

FlexMeasures comes with a command-line utility, which helps to manage data. Below, we list all available commands.

Each command has more extensive documentation if you call it with --help.

We keep track of changes to these commands in :ref:`cli-changelog`. You can also get the current overview over the commands you have available by:

flexmeasures --help

This also shows admin commands made available through Flask and installed extensions (such as Flask-Security and Flask-Migrate), of which some are referred to in this documentation.

add - Add data

flexmeasures add structure	Initialize structural data like asset types, market types and weather sensor types.
flexmeasures add user	Create a FlexMeasures user.
flexmeasures add asset	Create a new asset.
flexmeasures add weather-sensor	Add a weather sensor.
flexmeasures add external-weather-forecasts	Collect weather forecasts from the DarkSky API.
flexmeasures add forecasts	Create forecasts.

delete - Delete data

flexmeasures delete structure	Delete all structural (non time-series) data like assets (types), markets (types) and weather sensors (types) and users.
flexmeasures delete user	Delete a user & also their assets and power measurements.
flexmeasures delete measurements	Delete measurements (with horizon <= 0).
flexmeasures delete prognoses	Delete forecasts and schedules (forecasts > 0).

jobs - Job queueing

flexmeasures jobs run-worker	Start a worker process for forecasting and/or scheduling jobs.
flexmeasures jobs clear-queue	Clear a job queue.

db-ops - Operations on the whole database

flexmeasures db-ops dump	Create a dump of all current data (using pg_dump).
flexmeasures db-ops load	Load backed-up contents (see db-ops save), run reset first.
flexmeasures db-ops reset	Reset database data and re-create tables from data model.
flexmeasures db-ops restore	Restore the dump file, see db-ops dump (run reset first).
flexmeasures db-ops save	Backup db content to files.