71 lines
3.0 KiB
Markdown
71 lines
3.0 KiB
Markdown
# OONI Probe Client Library and CLI
|
|
|
|
[](https://godoc.org/github.com/ooni/probe-cli) [](https://github.com/ooni/probe-cli/actions?query=workflow%3Ashorttests) [](https://github.com/ooni/probe-cli/actions?query=workflow%3Aalltests) [](https://coveralls.io/github/ooni/probe-cli?branch=master) [](https://goreportcard.com/report/github.com/ooni/probe-cli) [](https://github.com/ooni/probe-cli/actions?query=workflow%3Alinux-debian-packages) [](https://github.com/ooni/probe/labels/ooni%2Fprobe-cli)
|
|
|
|
The next generation OONI Probe: client library and Command Line Interface.
|
|
|
|
## User setup
|
|
|
|
Please, follow the instructions at [ooni.org/install/cli](https://ooni.org/install/cli)
|
|
to install `ooniprobe`. If we do not support your use case, please let us know.
|
|
|
|
Once `ooniprobe` is installed, try `ooniprobe help` to get interactive help.
|
|
|
|
## Reporting issues
|
|
|
|
Please, report issues with this codebase at [github.com/ooni/probe](
|
|
https://github.com/ooni/probe/issues/new?labels=ooni/probe-cli&assignee=bassosimone).
|
|
Please, make sure you tag such issues using the `ooni/probe-cli` label.
|
|
|
|
## Repository organization
|
|
|
|
Every top-level directory contains an explanatory README file.
|
|
|
|
## Development setup
|
|
|
|
Be sure you have golang >= 1.16 and a C compiler (when developing for Windows, you
|
|
need Mingw-w64 installed). You can build using:
|
|
|
|
```bash
|
|
go build -v ./cmd/ooniprobe
|
|
```
|
|
|
|
This will generate a binary called `ooniprobe` in the current directory.
|
|
|
|
## Android bindings
|
|
|
|
```bash
|
|
./make -t android
|
|
```
|
|
|
|
Builds bindings for Android. (Add `----disable-embedding-psiphon-config` if you
|
|
cannot clone private repositories in the https://github.com/ooni namespace.)
|
|
|
|
The generated bindings are (manually) pushed to the Maven Central package
|
|
repository. The instructions explaining how to integrate these bindings
|
|
are published along with the release notes.
|
|
|
|
## iOS bindings
|
|
|
|
```bash
|
|
./make -t ios
|
|
```
|
|
|
|
Builds bindings for iOS. (Add `----disable-embedding-psiphon-config` if you
|
|
cannot clone private repositories in the https://github.com/ooni namespace.)
|
|
|
|
The generated bindings are (manually) added to GitHub releases. The instructions
|
|
explaining how to integrate these bindings are published along with the release notes.
|
|
|
|
## Updating dependencies
|
|
|
|
```bash
|
|
go get -u -v ./... && go mod tidy
|
|
```
|
|
|
|
## Releasing
|
|
|
|
Create an issue according to [the routine release template](
|
|
https://github.com/ooni/probe/blob/master/.github/ISSUE_TEMPLATE/routine-sprint-releases.md)
|
|
and perform any item inside the check-list.
|