ooni-probe-cli/Readme.md

65 lines
1.1 KiB
Markdown
Raw Normal View History

2018-08-01 12:16:11 +02:00
# OONI Probe CLI
2018-02-12 17:33:13 +01:00
2018-08-01 12:16:11 +02:00
The next generation OONI Probe Command Line Interface.
2018-02-12 17:33:13 +01:00
## Development setup
Be sure you have golang >= 1.8.
2018-03-08 10:27:59 +01:00
This project uses [`dep`](https://golang.github.io/dep/) with the `vendor/` dir
in `.gitignore`.
2018-02-12 17:33:13 +01:00
Once you have `dep` installed, run:
```
dep ensure
```
2018-03-08 10:27:59 +01:00
Next, you'll need a recent version of [Measurement Kit](http://github.com/measurement-kit).
Building a ooni binary for windows and macOS is currently only supported on a
macOS system.
For building a linux ooni binary, you will need a linux system and follow the
intruction in the linux section.
### macOS
On macOS you can build a windows and macOS ooni binary.
This can be done by running:
```
2018-09-11 12:40:39 +02:00
make download-mk-libs
```
This will download the prebuilt measurement-kit binaries.
Then you can build a macOS build by running:
2018-02-12 17:33:13 +01:00
```
make build
```
2018-03-08 10:27:59 +01:00
And a windows build by running:
```
make build-windows
```
### linux
On linux you can only build a linux ooni binary for amd64.
This can be done by running:
```
make download-mk-libs
2018-03-08 10:27:59 +01:00
```
Then you can build ooni by running:
```
make build
2018-03-08 10:27:59 +01:00
```