41 lines
931 B
Markdown
41 lines
931 B
Markdown
# OONI Probe CLI
|
|
|
|
The next generation OONI Probe Command Line Interface.
|
|
|
|
## User setup
|
|
|
|
1. Go [into the releases](https://github.com/ooni/probe-cli/releases) and download the release for your architecture and platform
|
|
|
|
2. Extract the tarball with `tar xvzf ooniprobe_*.tar.gz`
|
|
|
|
3. Copy the `ooniprobe` binary into a location in your `$PATH`, for example `/usr/local/bin/ooniprobe`
|
|
|
|
4. Run `ooniprobe run` to perform all the tests
|
|
|
|
Optional:
|
|
|
|
Add a crontab entry (on linux) to run `ooniprobe` daily at a random time:
|
|
|
|
```
|
|
(crontab -l 2>/dev/null; echo "$(( ( RANDOM % 60 ) + 1 )) $(( ( RANDOM % 24 ) + 1 )) * * * ooniprobe run") | crontab -
|
|
```
|
|
|
|
## Development setup
|
|
|
|
Be sure you have golang >= 1.13. We use golang modules. Run
|
|
|
|
```
|
|
./build.sh help
|
|
```
|
|
|
|
to get information on the supported systems as well as to get
|
|
instructions on how to install dependencies.
|
|
|
|
## Releasing
|
|
|
|
```
|
|
./build.sh release
|
|
```
|
|
|
|
and follow instructions.
|