2019-11-29 17:18:28 +01:00
# Command line flags
`-h, --help` Display help and exit
2019-11-29 17:24:16 +01:00
Supported: ✅
2019-11-29 17:18:28 +01:00
probe-cli equivalent: `-h, --help`
`-n, --no-collector` Disable writing to collector
2019-11-29 17:24:16 +01:00
Supported: ❌
2019-11-29 17:18:28 +01:00
Priority: high
`-N, --no-njson` Disable writing to disk
2019-11-29 17:24:16 +01:00
Supported: ❌
2019-11-29 17:18:28 +01:00
Priority: low
`-g, --no-geoip` Disable geoip lookup on start.
2019-11-29 17:24:16 +01:00
Supported: ❌
2019-11-29 17:18:28 +01:00
Priority: low
`-s, --list` List the currently installed ooniprobe nettests
2019-11-29 17:24:16 +01:00
Supported: ❌
2019-11-29 17:18:28 +01:00
Priority: low
`-w, --web-ui` Start the web UI
2019-11-29 17:24:16 +01:00
Supported: ❌
2019-11-29 17:18:28 +01:00
Priority: wontfix, we have no web UI in probe-cli
`-z, --initialize` Initialize ooniprobe to begin running it
2019-11-29 17:24:16 +01:00
Supported: ✅
2019-11-29 17:18:28 +01:00
probe-cli equivalent: `ooniprobe onboard`
`-o, --reportfile PATH_TO_FILE` Specify the report file name to write to.
2019-11-29 17:24:16 +01:00
Supported: ❌
2019-11-29 17:18:28 +01:00
Priority: medium
`-i, --testdeck PATH_TO_DECK` Specify as input a test deck: a yaml file containing the tests to run and their arguments.
2019-11-29 17:24:16 +01:00
Supported: ❌
2019-11-29 17:18:28 +01:00
Priority: wontfix, we have no deck support
`-c, --collector COLLECTOR_ADDRESS` Specify the address of the collector for test results. In most cases a user will prefer to specify a bouncer over this.
Supported: partially
probe-cli equivalent: edit ooniprobe.conf to specify the collector address in the options
`-b, --bouncer BOUNCER_ADDRESS` Specify the bouncer used to obtain the address of the collector and test helpers.
Supported: partially
probe-cli equivalent: edit ooniprobe.conf to specify the bouncer address in the options
`-l, --logfile PATH_TO_LOGFILE` Write to this logs to this filename.
2019-11-29 17:24:16 +01:00
Supported: ❌
2019-11-29 17:18:28 +01:00
Priority: medium
`-O, --pcapfile PATH_TO_PCAPFILE` Write a PCAP of the ooniprobe session to this filename.
2019-11-29 17:24:16 +01:00
Supported: ❌
2019-11-29 17:18:28 +01:00
Priority: wontfix, we don't have packet capture support in probe-cli
`-f, --configfile PATH_TO_CONFIG` Specify a path to the ooniprobe configuration file.
2019-11-29 17:24:16 +01:00
Supported: ✅
2019-11-29 17:18:28 +01:00
probe-cli equivalent: `--config`
`-d, --datadir` Specify a path to the ooniprobe data directory.
2019-11-29 17:24:16 +01:00
Supported: ✅
2019-11-29 17:18:28 +01:00
probe-cli equivalent: set the `OONI_HOME` environment variable
`-a, --annotations key:value[,key2:value2]` Annotate the report with a key:value[, key:value] format.
2019-11-29 17:24:16 +01:00
Supported: ✅
2019-11-29 17:18:28 +01:00
Priority: high
`-P, --preferred-backend onion|https|cloudfront` Set the preferred backend to use when submitting results and/or communicating with test helpers. Can be either onion, https or cloudfront
2019-11-29 17:24:16 +01:00
Supported: ❌
2019-11-29 17:18:28 +01:00
Priority: wontfix, we don't support any other backend beyond https, yet we will
and yet we would prefer to have the logic of reporting be managed by the probe
itself and not expose this setting.
# Features
* Run a test deck
2019-11-29 17:24:16 +01:00
Supported: ✅
2019-11-29 17:18:28 +01:00
probe-cli equivalent: we now call a test deck a test group and we have them
coded into the logic of the client
* Run an individual netttest
2019-11-29 17:24:16 +01:00
Supported: ❌
2019-11-29 17:18:28 +01:00
Priority: medium
* Upload a measurement like `oonireport upload`
2019-11-29 17:24:16 +01:00
Supported: ❌
2019-11-29 17:18:28 +01:00
Priority: medium
* Test an individual URL with web_connectivity
2019-11-29 17:24:16 +01:00
Supported: ❌
2019-11-29 17:18:28 +01:00
Priority: high
* Run tests automatically like `ooniprobe-agent`
2019-11-29 17:24:16 +01:00
Supported: ❌
2019-11-29 17:18:28 +01:00
Priority: high
* Write custom tests like OONI test templates
2019-11-29 17:24:16 +01:00
Supported: ❌
2019-11-29 17:18:28 +01:00
Priority: medium
* Packet captures
2019-11-29 17:24:16 +01:00
Supported: ❌
2019-11-29 17:18:28 +01:00
Priority: low
* Upload measurements using onion services
2019-11-29 17:24:16 +01:00
Supported: ❌
2019-11-29 17:18:28 +01:00
Priority: low
* Log level support to aid debugging
2019-11-29 17:24:16 +01:00
Supported: ❌
2019-11-29 17:18:28 +01:00
Priority: medium
* Measurement quota to limit the disk usage
2019-11-29 17:24:16 +01:00
Supported: ❌
2019-11-29 17:18:28 +01:00
Priority: high
* Failover strategies for uploading measurements (use https then onion then cloudfront)
2019-11-29 17:24:16 +01:00
Supported: ❌
2019-11-29 17:18:28 +01:00
Priority: high