Link
kosher

This site uses Just the Docs, a documentation theme for Jekyll.

Search

CLI

kosher is a command-line utility; thus, you interface with it via the following terminal commands:

Commands

  1. init
    1. Format
    2. Flags
    3. Arguments
  2. run
    1. Format
    2. Flags
    3. Arguments
  3. send
    1. Format
    2. Flags
  4. send jira
    1. Format
    2. Flags
  5. version
    1. Format
    2. Flags
    3. Arguments
  6. help
    1. Format
    2. Flags
    3. Arguments

init

init creates the necessary project structure with simple example tests and config files to quickly get you started.

Format 

$ kosher init [flags] [project name] [directory]

Flags

Flag Description
-e, –empty init creates the necessary project structure with simple example tests and config files to quickly get you started.
-f, –force Create a project inside a non-empty directory.
-h, –help help for init
-p, –platform Set the platform: desktop, web (default “web”)

Arguments

Argument Required Description
project name yes Name of the new project being initialized.
directory no Relative path to subdirectory to initialize the new project in.

run

run executes one or more *.feature files of the current project. This command must be executed from the root of the kosher project.

Format 

$ kosher run [flags] [path]

Flags

Flag Description
–appVersion Version of the application being tested. This will be used when creating the report after testing has completed.
-e, –environment Sets the environment to execute tests against. This overrides the default environemnt specified in config/settings.json.
-t, –tags Filter features, scenarios, scenario outlines, and examples by tags.
-h, –help help for run

Arguments

Argument Required Description
path no Providing this argument restricts the selection of *.feature files executed to a specific subfolder or even a specific file. Standard Linux glob patterns are accepted.

send

send is the parent command for all integration commands. It must be followed by an integration command.

Format 

$ kosher send [flags]

Flags

Flag Description
-h, –help help for send

send jira

send jira is the command to create Jira issues for failed kosher test scenarios. For more details, see Jira Integration.

Format 

$ kosher send jira [flags]

Flags

Flag Description
–default Use default parameters defined in the settings.json file.
-h, –help help for send jira

version

version prints the version of kosher running to the terminal.

Format 

$ kosher version [flags]

Flags

Flag Description
-h, –help help for version

Arguments

There are no arguments for version.

help

help prints the usage instructions for kosher to the terminal.

Format 

$ kosher help [flags] [command]

Flags

Flag Description
-h, –help help for help

Arguments

Argument Required Description
command no Specifies a kosher command to print the help for.