timepigeon / probe-cli

Next generation OONI Probe. Library and CLI tool.

OONI Probe Client Library and CLI

• Documentation:

• go test -race -short ./... status:

• go test -race ./... status:

• Code coverage for -short tests:

• Go Report Card:

• Debian package builds:

• Open issues:

The next generation OONI Probe: client library and Command Line Interface.

User setup

Please, follow the instructions at 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

Report issues at github.com/ooni/probe. Please, make sure you add the ooni/probe-cli label.

Repository organization

Every top-level directory contains an explanatory README file.

ooniprobe

Be sure you have golang >= 1.16 and a C compiler (Mingw-w64 for Windows). You can build using:

go build -v ./cmd/ooniprobe

This will generate a binary called ooniprobe in the current directory.

Android bindings

Make sure you have GNU make installed, then run:

./mk android

to build bindings for Android. (Add OONI_PSIPHON_TAGS="" 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

Make sure you have GNU make installed, then run:

./mk ios

to build bindings for iOS. (Add OONI_PSIPHON_TAGS="" 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.

miniooni

Miniooni is the experimental OONI client used for research. Compile using:

go build -v ./internal/cmd/miniooni

This will generate a binary called miniooni in the current directory.

Specification

Every nettest (aka experiment) implemented in this repository has a companion spec in the ooni/spec repository.

Updating dependencies

go get -u -v ./... && go mod tidy

Releasing

Create an issue according to the routine release template and perform any item inside the check-list.

We build releases using ./mk, which requires GNU make. Try the ./mk help|less command for detailed usage.