libminiooni

README

Package github.com/ooni/probe-cli/internal/libminiooni

Package libminiooni implements the cmd/miniooni CLI. Miniooni is our experimental client used for research and QA testing.

This CLI has CLI options that do not conflict with Measurement Kit v0.10.x CLI options. There are some options conflict with the legacy OONI Probe CLI options. Perfect backwards compatibility is not a design goal for miniooni. Rather, we aim to have as little conflict as possible such that we can run side by side QA checks.

This package was split off from cmd/miniooni in ooni/probe-engine. For now we are keeping this split, but we will merge them in the future.

Documentation

Overview

Package libminiooni implements the cmd/miniooni CLI. Miniooni is our experimental client used for research and QA testing.

This CLI has CLI options that do not conflict with Measurement Kit v0.10.x CLI options. There are some options conflict with the legacy OONI Probe CLI options. Perfect backwards compatibility is not a design goal for miniooni. Rather, we aim to have as little conflict as possible such that we can run side by side QA checks.

We extracted this package from cmd/miniooni to allow us to further integrate the miniooni CLI into other binaries (see for example the code at github.com/bassosimone/aladdin).

Index

• func Main()
• func MainWithConfiguration(experimentName string, currentOptions Options)
• type Options

Functions

func Main

func Main()

Main is the main function of miniooni. This function parses the command line options and uses a global state. Use MainWithConfiguration if you want to avoid using any global state and relying on command line options.

This function will panic in case of a fatal error. It is up to you that integrate this function to either handle the panic of ignore it.

func MainWithConfiguration

func MainWithConfiguration(experimentName string, currentOptions Options)

MainWithConfiguration is the miniooni main with a specific configuration represented by the experiment name and the current options.

This function will panic in case of a fatal error. It is up to you that integrate this function to either handle the panic of ignore it.

Types

type Options

type Options struct {
	Annotations      []string
	ExtraOptions     []string
	HomeDir          string
	Inputs           []string
	InputFilePaths   []string
	NoJSON           bool
	NoCollector      bool
	ProbeServicesURL string
	Proxy            string
	Random           bool
	ReportFile       string
	SelfCensorSpec   string
	TorArgs          []string
	TorBinary        string
	Tunnel           string
	Verbose          bool
	Yes              bool
}

Options contains the options you can set from the CLI.