Fandango Command Reference#
All Commands#
Here is a list of all fandango commands:
usage: fandango [-h] [--version] [--verbose | --quiet]
{fuzz,parse,shell,help,copyright,version} ...
The access point to the Fandango framework
options:
-h, --help show this help message and exit
--version show version number
--verbose, -v increase verbosity. Can be given multiple times (-vv)
--quiet, -q decrease verbosity. Can be given multiple times (-qq)
commands:
{fuzz,parse,shell,help,copyright,version}
the command to execute
fuzz produce outputs from .fan files and test programs
parse parse input file(s) according to .fan spec
shell run an interactive shell (default)
help show this help and exit
copyright show copyright
version show version
Use `fandango help` to get a list of commands.
Use `fandango help COMMAND` to learn more about COMMAND.
See https://fandango-fuzzer.github.io/ for more information.
Fuzzing#
To produce outputs with fandango, use fandango fuzz:
usage: fandango fuzz [-h] [-f FAN_FILE] [-c CONSTRAINT] [--no-cache]
[--no-stdlib] [-s SEPARATOR] [-I DIR] [-d DIRECTORY]
[-x FILENAME_EXTENSION]
[--format {string,bits,tree,grammar,value,repr,none}]
[--file-mode {text,binary,auto}] [--validate]
[-S START_SYMBOL] [--warnings-are-errors]
[-N MAX_GENERATIONS] [--population-size POPULATION_SIZE]
[--elitism-rate ELITISM_RATE]
[--crossover-rate CROSSOVER_RATE]
[--mutation-rate MUTATION_RATE]
[--random-seed RANDOM_SEED]
[--destruction-rate DESTRUCTION_RATE]
[--max-repetition-rate MAX_REPETITION_RATE]
[--max-repetitions MAX_REPETITIONS]
[--max-node-rate MAX_NODE_RATE] [--max-nodes MAX_NODES]
[-n NUM_OUTPUTS] [--best-effort] [-i INITIAL_POPULATION]
[-o OUTPUT] [--input-method {stdin,filename}]
[command] ...
options:
-h, --help show this help message and exit
-f, --fandango-file FAN_FILE
Fandango file (.fan, .py) to be processed. Can be
given multiple times. Use '-' for stdin
-c, --constraint CONSTRAINT
define an additional constraint CONSTRAINT. Can be
given multiple times.
--no-cache do not cache parsed Fandango files.
--no-stdlib do not use standard library when parsing Fandango
files.
-s, --separator SEPARATOR
output SEPARATOR between individual inputs. (default:
newline)
-I, --include-dir DIR
specify a directory DIR to search for included
Fandango files
-d, --directory DIRECTORY
create individual output files in DIRECTORY
-x, --filename-extension FILENAME_EXTENSION
extension of generated file names (default: '.txt')
--format {string,bits,tree,grammar,value,repr,none}
produce output(s) as string (default), as a bit
string, as a derivation tree, as a grammar, as a
Python value, in internal representation, or none
--file-mode {text,binary,auto}
mode in which to open and write files (default is
'auto': 'binary' if grammar has bits or bytes, 'text'
otherwise)
--validate run internal consistency checks for debugging
-o, --output OUTPUT write output to OUTPUT (default: stdout)
general settings:
-S, --start-symbol START_SYMBOL
the grammar start symbol (default: `<start>`)
--warnings-are-errors
treat warnings as errors
algorithm settings:
-N, --max-generations MAX_GENERATIONS
the maximum number of generations to run the algorithm
--population-size POPULATION_SIZE
the size of the population
--elitism-rate ELITISM_RATE
the rate of individuals preserved in the next
generation
--crossover-rate CROSSOVER_RATE
the rate of individuals that will undergo crossover
--mutation-rate MUTATION_RATE
the rate of individuals that will undergo mutation
--random-seed RANDOM_SEED
the random seed to use for the algorithm
--destruction-rate DESTRUCTION_RATE
the rate of individuals that will be randomly
destroyed in every generation
--max-repetition-rate MAX_REPETITION_RATE
rate at which the number of maximal repetitions should
be increased
--max-repetitions MAX_REPETITIONS
Maximal value, the number of repetitions can be
increased to
--max-node-rate MAX_NODE_RATE
rate at which the maximal number of nodes in a tree is
increased
--max-nodes MAX_NODES
Maximal value, the number of nodes in a tree can be
increased to
-n, --num-outputs, --desired-solutions NUM_OUTPUTS
the number of outputs to produce (default: 100)
--best-effort produce a 'best effort' population (may not satisfy
all constraints)
-i, --initial-population INITIAL_POPULATION
directory or ZIP archive with initial population
command invocation settings:
--input-method {stdin,filename}
when invoking COMMAND, choose whether Fandango input
will be passed as standard input (`stdin`) or as last
argument on the command line (`filename`) (default)
command command to be invoked with a Fandango input
args the arguments of the command
Parsing#
To parse inputs with fandango, use fandango parse:
usage: fandango parse [-h] [-f FAN_FILE] [-c CONSTRAINT] [--no-cache]
[--no-stdlib] [-s SEPARATOR] [-I DIR] [-d DIRECTORY]
[-x FILENAME_EXTENSION]
[--format {string,bits,tree,grammar,value,repr,none}]
[--file-mode {text,binary,auto}] [--validate]
[-S START_SYMBOL] [--warnings-are-errors] [--prefix]
[-o OUTPUT]
[files ...]
positional arguments:
files files to be parsed. Use '-' for stdin
options:
-h, --help show this help message and exit
-f, --fandango-file FAN_FILE
Fandango file (.fan, .py) to be processed. Can be
given multiple times. Use '-' for stdin
-c, --constraint CONSTRAINT
define an additional constraint CONSTRAINT. Can be
given multiple times.
--no-cache do not cache parsed Fandango files.
--no-stdlib do not use standard library when parsing Fandango
files.
-s, --separator SEPARATOR
output SEPARATOR between individual inputs. (default:
newline)
-I, --include-dir DIR
specify a directory DIR to search for included
Fandango files
-d, --directory DIRECTORY
create individual output files in DIRECTORY
-x, --filename-extension FILENAME_EXTENSION
extension of generated file names (default: '.txt')
--format {string,bits,tree,grammar,value,repr,none}
produce output(s) as string (default), as a bit
string, as a derivation tree, as a grammar, as a
Python value, in internal representation, or none
--file-mode {text,binary,auto}
mode in which to open and write files (default is
'auto': 'binary' if grammar has bits or bytes, 'text'
otherwise)
--validate run internal consistency checks for debugging
--prefix parse a prefix only
-o, --output OUTPUT write output to OUTPUT (default: none). Use '-' for
stdout
general settings:
-S, --start-symbol START_SYMBOL
the grammar start symbol (default: `<start>`)
--warnings-are-errors
treat warnings as errors
Shell#
To enter commands in fandango, use fandango shell or just fandango:
usage: fandango shell [-h]
options:
-h, --help show this help message and exit