c/ooni-probe-cli
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
592 Commits 6 Branches 0 Tags 8.8 MiB
Go 97.6%
Python 1.2%
Shell 0.9%
Makefile 0.3%
c258a0fedd
Go to file
Simone Basso c258a0fedd
CLI, debian, make: misc cleanup and changes (#336) 
This PR	groups misc cleanup and changes from https://github.com/ooni/probe-cli/pull/331.

* CLI/linux/build: add documentation

* debian/.gitignore: ignore generated files

* debian/TODO: unnecessary at this point

* debian/ooniprobe-cli.service: remove commented out lines

* debian/rules: remove unnecessary actions

* make: reindent and fix spelling

* smoketest.sh: don't run in verbose mode

Part of https://github.com/ooni/probe/issues/1466
2021-05-06 21:20:45 +02:00
.github/workflows refactor(.github/workflows): linux: use ./make, run less frequently (#334) 2021-05-06 20:44:56 +02:00
.vscode feat(make): sign more generated binaries (#330) 2021-05-05 14:26:19 +02:00
CLI CLI, debian, make: misc cleanup and changes (#336) 2021-05-06 21:20:45 +02:00
cmd Add support for tracking the is_uploaded status in the results table (#312) 2021-04-30 17:08:16 +02:00
debian CLI, debian, make: misc cleanup and changes (#336) 2021-05-06 21:20:45 +02:00
docs doc: ensure all top dirs have an explanatory README (#214) 2021-02-03 16:54:00 +01:00
E2E refactor: redesign how we import assets (#260) 2021-04-01 16:57:31 +02:00
internal fix(tunnel): pass /absolute/path/to/tor to cretz/bine (#323) 2021-05-04 08:14:25 +02:00
MOBILE refactor(make): better checks for tool existence and paths (#327) 2021-05-05 11:33:51 +02:00
pkg chore: link new TODOs with the relevant issues (#321) 2021-04-29 18:43:31 +02:00
QA refactor: redesign how we import assets (#260) 2021-04-01 16:57:31 +02:00
.gitignore feat(make): sign more generated binaries (#330) 2021-05-05 14:26:19 +02:00
build.sh refactor: redesign how we import assets (#260) 2021-04-01 16:57:31 +02:00
CODE_OF_CONDUCT.md doc: add code of conduct (#157) 2020-11-03 21:16:04 +01:00
CODEOWNERS chore: continue merging probe-engine into probe-cli (#211) 2021-02-03 14:42:51 +01:00
CONTRIBUTING.md doc: merge the engine and the cli readmes (#215) 2021-02-03 19:29:12 +01:00
go.mod More progress towards release v3.10.0 (#320) 2021-04-29 15:59:53 +02:00
go.sum More progress towards release v3.10.0 (#320) 2021-04-29 15:59:53 +02:00
LICENSE.md Add LICENSE.md 2018-07-11 18:06:27 +02:00
make CLI, debian, make: misc cleanup and changes (#336) 2021-05-06 21:20:45 +02:00
Readme.md feat(make): build miniooni (#322) 2021-04-29 19:24:25 +02:00
smoketest.sh CLI, debian, make: misc cleanup and changes (#336) 2021-05-06 21:20:45 +02:00
testjafar.bash refactor: enable QA tests and jafar self test (#208) 2021-02-03 13:20:37 +01:00

Readme.md

OONI Probe Client Library and CLI

GoDoc Short Tests Status All Tests Status Coverage Status Go Report Card linux-debian-packages GitHub issues by-label

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

Please, report issues with this codebase at github.com/ooni/probe. Please, make sure you tag such issues using 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 (when developing for Windows, you need Mingw-w64 installed). 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 Python 3.8+ installed, then run:

./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

Make sure you have Python 3.8+ installed, then run:

./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.

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.

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 ./make, which requires Python3.8+.