Browse Source

Added reports CLI documentation

Jeremy Stretch 7 years ago
parent
commit
bb898b719f
1 changed files with 10 additions and 0 deletions
  1. 10 0
      docs/miscellaneous/reports.md

+ 10 - 0
docs/miscellaneous/reports.md

@@ -117,3 +117,13 @@ Our example report above would be called as:
 ```
     POST /api/extras/reports/devices.DeviceConnectionsReport/run/
 ```
+
+### Via the CLI
+
+Reports can be run on the CLI by invoking the management command:
+
+```
+python3 manage.py runreport <module>
+```
+
+One or more report modules may be specified.