CLI Reference

In this section we provide a quick reference for the Command Line Interface (CLI) of CTLog.

ctlog - CLI interface

SAT-based Combinatorial Testing algorithms and tools in Python.

ctlog [-h] {mcac,tn,gen,version} ...

ctlog options

-h, --help - show this help message and exit

ctlog mcac

Mixed Covering Arrays with Constraints (MCACs) algorithms and tools.

sphinx-build mcac [-h] {algorithms,encoders} ...

ctlog mcac positional arguments

mcac_command (default: None)

ctlog mcac options

-h, --help - show this help message and exit

ctlog tn

Tuple Number (TN) algorithms and tools.

sphinx-build tn [-h] {encoders} ...

ctlog tn positional arguments

tn_command (default: None)

ctlog tn options

-h, --help - show this help message and exit

ctlog gen

SUT-G Model Generator.

sphinx-build gen [-h] --timeout TIMEOUT --num-params NUM_PARAMS --out-file OUT_FILE
                 [--num-seeds NUM_SEEDS] [--max-confl MAX_CONFL] [--min-confl MIN_CONFL]
                 [--inc-assumps INC_ASSUMPS] [--dec-assumps DEC_ASSUMPS]
                 [--max-tries MAX_TRIES] [--seed SEED]
                 cnf_file

ctlog gen positional arguments

cnf_file - Path to the input CNF file. (default: None)

ctlog gen options

-h, --help - show this help message and exit
--timeout TIMEOUT, -t TIMEOUT - Solving timeout (in seconds). (default: None)
--num-params NUM_PARAMS, -n NUM_PARAMS - Number of parameters for the output SUT model. (default: None)
--out-file OUT_FILE, -o OUT_FILE - Output file. (default: None)
--num-seeds NUM_SEEDS, -ns NUM_SEEDS - Number of seeds to estimate the formula hardness. (default: 5)
--max-confl MAX_CONFL - Maximum number of conflicts for the resulting formula. (default: 10000)
--min-confl MIN_CONFL - Minimum number of conflicts for the resulting formula. (default: 5000)
--inc-assumps INC_ASSUMPS - Number of variables that will be used to increase the solver assumptions. (default: 10)
--dec-assumps DEC_ASSUMPS - Number of variables that will be used to decrese the solver assumptions. (default: 5)
--max-tries MAX_TRIES - Maximum number of tries to generate the SUT model before giving up. (default: 100)
--seed SEED, -s SEED - RNG seed. (default: 123456)

ctlog version

Print CTLog version and exit.

sphinx-build version [-h]

ctlog version options

-h, --help - show this help message and exit

MCAC

ctlog mcac algorithms - CLI interface

Generate and MCAC using some of the implemented algorithms.

ctlog mcac algorithms [-h] {list,help,run} ...

ctlog mcac options

-h, --help - show this help message and exit

ctlog mcac algorithms list

List all available MCAC algorithm classes.

ctlog mcac algorithms list [-h]

ctlog mcac options

-h, --help - show this help message and exit

ctlog mcac algorithms help

Show the docstring and parameters of an algorithm.

ctlog mcac algorithms help [-h] algorithm

ctlog mcac positional arguments

algorithm - Name of the algorithm class. (default: None)

ctlog mcac options

-h, --help - show this help message and exit

ctlog mcac algorithms run

Run an MCAC algorithm with dynamic parameters.

ctlog mcac algorithms run [-h] [--ub UB] [--sut-format SUT_FORMAT] [--out-file OUT_FILE]
                          [--out-format OUT_FORMAT] [--skip-validation]
                          [--all-missing-tuples] [--args [ARGS ...]]
                          algorithm sut_file strength

ctlog mcac positional arguments

algorithm - Name of the algorithm class. (default: None)
sut_file - Path to the SUT model. (default: None)
strength - MCAC strength. (default: None)

ctlog mcac options

-h, --help - show this help message and exit
--ub UB - Upper bound for the MCAC algorithm (if needed). (default: None)
--sut-format SUT_FORMAT - SUT file format. (default: acts)
--out-file OUT_FILE - MCAC output file (if None, outputs to stdout). (default: None)
--out-format OUT_FORMAT - Output format (csv or acts). (default: csv)
--skip-validation - Skip MCAC validation.
--all-missing-tuples - Show the number of missing tuples (when –skip-validation is deactivated).
--args ARGS - Arguments to pass to the algorithm as key=value. (default: [])

ctlog mcac encoders - CLI interface

MCAC SAT/MaxSAT encoders.

ctlog mcac encoders [-h] {maxsat,sat} ...

ctlog mcac options

-h, --help - show this help message and exit

ctlog mcac encoders maxsat

ctlog mcac encoders maxsat [-h] [--sut-format SUT_FORMAT] [--encoding ENCODING]
                           sut_file strength ub

ctlog mcac positional arguments

sut_file - Path to the SUT model. (default: None)
strength - MCAC strength. (default: None)
ub - Upper bound for the encoder. (default: None)

ctlog mcac options

-h, --help - show this help message and exit
--sut-format SUT_FORMAT - SUT file format. (default: acts)
--encoding ENCODING - MaxSAT encoding (ccx, cx, ccx-a1). (default: ccx)

ctlog mcac encoders sat

ctlog mcac encoders sat [-h] [--sut-format SUT_FORMAT] [--store-cvars] sut_file strength ub

ctlog mcac positional arguments

sut_file - Path to the SUT model. (default: None)
strength - MCAC strength. (default: None)
ub - Upper bound for the encoder. (default: None)

ctlog mcac options

-h, --help - show this help message and exit
--sut-format SUT_FORMAT - SUT file format. (default: acts)
--store-cvars - Store and show cvars.

TN

ctlog tn encoders - CLI interface

Tuple Number MaxSAT encoder.

ctlog tn encoders [-h] {maxsat} ...

ctlog tn options

-h, --help - show this help message and exit

ctlog tn encoders maxsat

ctlog tn encoders maxsat [-h] [--sut-format SUT_FORMAT] [--soft-param-tuples]
                         [--no-filter-allowed]
                         sut_file strength

ctlog tn positional arguments

sut_file - Path to the SUT model. (default: None)
strength - MCAC strength. (default: None)

ctlog tn options

-h, --help - show this help message and exit
--sut-format SUT_FORMAT - SUT file format. (default: acts)
--soft-param-tuples - Write parameter tuples as soft clauses.
--no-filter-allowed - Do not filter allowed tuples before encoding the WCNF formula.