Command Line Interface¶
WuttaFarm ships with the following commands.
For more general info about CLI see Command Line.
wuttafarm install¶
Run the WuttaFarm app installer.
This will create the app dir and initial config files, and create the schema within the app database.
Defined in: wuttafarm.cli.install
/mnt/buildbot/worker/wuttafarm/build/.tox/docs/lib/python3.13/site-packages/pyramid/path.py:5: UserWarning: pkg_resources is deprecated as an API. See https://setuptools.pypa.io/en/latest/pkg_resources.html. The pkg_resources package is slated for removal as early as 2025-11-30. Refrain from using this package or pin to Setuptools<81.
import pkg_resources
Usage: wuttafarm install [OPTIONS]
Install the WuttaFarm app
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
wuttafarm import-farmos¶
Import data from the farmOS API into the WuttaFarm app database.
Defined in: wuttafarm.cli.import_farmos
/mnt/buildbot/worker/wuttafarm/build/.tox/docs/lib/python3.13/site-packages/pyramid/path.py:5: UserWarning: pkg_resources is deprecated as an API. See https://setuptools.pypa.io/en/latest/pkg_resources.html. The pkg_resources package is slated for removal as early as 2025-11-30. Refrain from using this package or pin to Setuptools<81.
import pkg_resources
Usage: wuttafarm import-farmos [OPTIONS] [models]...
Import data from farmOS API to WuttaFarm
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ models <str> Target model(s) to process. Specify one or more, or │
│ omit to process default models. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --list-models -l List available target models and │
│ exit. │
│ --create --no-create Allow new target records to be │
│ created. See aso --max-create. │
│ [default: create] │
│ --update --no-update Allow existing target records to │
│ be updated. See also │
│ --max-update. │
│ [default: update] │
│ --delete --no-delete Allow existing target records to │
│ be deleted. See also │
│ --max-delete. │
│ [default: no-delete] │
│ --fields <str> List of fields to process. See │
│ also --exclude and --key. │
│ --exclude <str> List of fields *not* to process. │
│ See also --fields. │
│ --key,--keys <str> List of fields to use as record │
│ key/identifier. See also │
│ --fields. │
│ --max-create <int> Max number of target records to │
│ create (per model). See also │
│ --create. │
│ --max-update <int> Max number of target records to │
│ update (per model). See also │
│ --update. │
│ --max-delete <int> Max number of target records to │
│ delete (per model). See also │
│ --delete. │
│ --max-total <int> Max number of *any* target │
│ record changes which may occur │
│ (per model). │
│ --warn -W Expect no changes; warn (email │
│ the diff) if any occur. │
│ --recip,--recips <str> Override the recipient(s) for │
│ diff warning email. │
│ --max-diffs <int> Max number of record diffs to │
│ show (per model) in warning │
│ email. │
│ [default: 15] │
│ --dry-run Go through the motions, but │
│ rollback the transaction. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯