Command Line Interface
CLI
Basic syntax is:
where:
A parameter between
[and]means that it is optional.[dir]is the directory that contains your.featurefiles. Whether it is not informed, the tool searches all the subdirectories from the current path.[options]changes how the tool behaves.
You can run concordia --help to see all the command line interface (CLI) options.
You need to use npx before the commands if you opted for a local installation.
Configuration
--config
Indicates a configuration file
Alias: -c
By default the configuration file is loaded from the current directory.
--init
Creates a configuration file and optionally installs plug-ins and databases.
This command asks about your preferences. By hitting Enter without giving an answer, it will select the suggested (default) value. You can use Up and Down to navigate the answers and hit Enter to select it. For multiple selection (when available), hitSpace.
By using a configuration file (e.g. .concordiarc) you avoid informing the configured parameters in the console/terminal. For instance, whether plugin is defined in the configuration file, you don't need to inform --plugin anymore.
CLI options take precedence over values from configuration files.
--save-config
Add CLI parameters to the configuration file
The following example will consider the given directory and add it to the configuration file:
Directories and files
--directory
Indicates the directory that has
.featureand.testcasefiles.
Alias: -d
When not given, it will search the current directory and all subdirectories recursively.
We strongly recommend to use it or set it in the configuration file.
Example:
This is equivalent to:
You can use it with --no-recursive to disable recursive search.
--file
Specifies
.featurefiles to consider
Aliases: -f, --files
Files must be separated by comma.
Whether the command also informs a directory (e.g. --directory), it searches the files inside the directory. Example:
The example above will search for ./feature/f1.feature and ./feature/f1.feature.
--ignore
Specify
.featurefiles to ignore when a directory is informed
Alias: -i
Files must be separated by comma.
--no-recursive
Disables recursive search when a directory is informed
Output directories
The directories will be used by a plug-in. We strongly recommend that you specify them in a configuration file.
--dir-result
Specifies the directory for test reports and screenshots.
Alias: -O
--dir-script
Specifies the directory for test script files.
Alias: -o
Language and locale
--language
Sets the default language to consider.
Alias: -l
The language code must have only 2 characters and needs to be one of the available languages.
--language-list
Lists the available language codes.
--locale-list
Lists the available locales.
Processing and output
--just-script
Just generates test scripts
--just-spec
Just verifies specification files
--just-test-case
Just generates test cases
--just-run
Just execute test script files
--no-script
Avoids generating test scripts
--no-spec
Avoids processing specification files
--no-test-case
Avoids generating test cases
--no-result
Avoids reading test scripts' results
--no-run
Avoids running test scripts
Use -x to combine --no-run and --no-result
--verbose
Uses a verbose output
Test script execution
These parameters require a plugin (--plugin) and some plug-ins may not support them.
--instances
Number of parallel instances to execute.
Alias: -I
--headless
Executes browsers in headless mode.
Alias: -H
--script-file
Sets one or more test script files to execute
Aliases: -F, --script-files
Files must be separated by comma.
--script-grep
Sets a text or regular expression to filter the files to execute
Alias: -G
--target
Sets target browsers or platforms to execute
Alias: -T
Browser or platforms must be separated by comma.
Plug-in
You can omit the prefix concordialang- from plug-in names. For instance, concordialang-codeceptjs-playwright becomescodeceptjs-playwright.
--plugin
Uses the given plug-in (if installed)
Alias: -p
You can use it with -x to avoid running test scripts and reading their output:
--plugin-about
Shows information about an installed plug-in
Alias: --plugin-info
--plugin-install
Installs a plug-in
--plugin-list
Lists installed plug-ins
--plugin-serve
Starts a testing server for a plug-in
Alias: -S
The testing server will keep running. Thus, it's a good idea to open a separate terminal/console for it. To stop it later, type Ctrl + C.
--plugin-uninstall
Uninstalls a plug-in
Database
See Using Databases for the list of available databases.
--db-install
Installs a database driver
--db-list
Lists installed databases
--db-uninstall
Uninstalls a database driver
Random generation
--random-max-string-size
Maximum random string size to generate, when free values are allowed.
The default value is 500 .
--random-min-string-size
Minimum random string size to generate, when free values are allowed.
The default value is 0 .
--random-tries
Random tries to generate invalid values.
When there is a set of valid values and any value different from those in the set is considered an invalid, random generation is used to produce an invalid value. This parameter defines how many tries to take. Usually it gets on the first try.
The default value is 5 .
--seed
Sets a random seed
Concordia Compiler can use random selection in its algorithms. By default, it generates the seed using the current date and time. Using the same seed makes the algorithms produce the same output (e.g., same values and paths). While that's interesting for reproducing a past behavior, we don't recommend it for finding new defects. Using new seeds, Concordia Compiler will select different test data, test oracles, and test paths over time.
You can also set the algorithms to use, in order to avoid random selection. Full combination (therefore full coverage of the requirements) can be achieved and it is recommend for complete checking before a new release. However, it may take some time to execute.
Combination strategies
--comb-data
--comb-invalid
--comb-state
--comb-variant
File formats and extensions
You probably don't need to use them, unless you're facing problems to read files.
--line-breaker
Sets the character(s) used for breaking lines.
Since by default the line breaker is detected automatically, this command may not be useful for you in most cases.
Note on line breakers:
Linux uses
"\n"MacOS uses
"\r"Windows uses
"\r\n"
--encoding
Sets the expected file encoding
Alias: -e
The default is utf8. Possible values are:
asciilatin1ucs2orucs-2utf16leorutf-16leutf8orutf-8
Information
--about
Shows information about the compiler.
--help
Shows the available commands
--newer
Verify if there is a newer version.
--version
Shows the current version.
Last updated