<< back

Commands

Available command functions: 1. Show help 2. Show version 3. Create new test skeleton 4. Check teuton test 5. Run teuton test * Running Teuton test * Command options * Choosing other config file name

1. Show help

Usage:

teuton

Example:

> teuton
Commands:
  teuton [run] [OPTIONS] DIRECTORY  # Run challenge from directory
  teuton check [OPTIONS] DIRECTORY  # Test or check challenge contents
  teuton help [COMMAND]             # Describe available commands or one specific command
  teuton new DIRECTORY              # Create skeleton for a new project
  teuton readme DIRECTORY           # Create README.md file from challenge contents
  teuton version                    # Show the program version

2. Show version

Usage:

teuton version

Example:

$ teuton version                               
teuton (version 2.1.9)

Alias: * teuton v * teuton -v * teuton --version

3. Create new test skeleton

Usage:

teuton new foo

Example:

> teuton new foo

[INFO] Creating foo project skeleton
* Create dir        => foo
* Create file       => foo/config.yaml
* Create file       => foo/start.rb
* Create file       => foo/.gitignore

This command will create the next structure:

| File/Directory | Description | | ————— | ————– | | foo | Base directory | | foo/start.rb | Main Script | | foo/config.yaml | YAML configuration file | | foo/.gitignore | By default, ignore YAML files to be upload on git repository |

5. Check teuton test

Usage:

teuton check DIRPATH

Description: this command check teuton test source files,located into DIRPATH folder.

Example

4. Run teuton test

Usage:

teuton run DIRPATH

Description: this command run teuton test located into DIRPATH folder.

Example