Skip to content

Latest commit

 

History

History
142 lines (99 loc) · 2.85 KB

README.md

File metadata and controls

142 lines (99 loc) · 2.85 KB
Raw

<< back

Commands

Available command functions:

  1. Show help
  2. Show version
  3. Create new test
  4. Check teuton test
  5. Run teuton test

1. Show help

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

Alias:

  • teuton h
  • teuton -h
  • teuton --help

2. Show version

teuton version

Example:

$ teuton version                               
teuton (version 2.2.0)

Alias:

  • teuton v
  • teuton -v
  • teuton --version

3. Create new test

Create teuton test skeleton.

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

This command will create the next structure:

File/Directory Description
foo Base directory
foo/start.rb Main Script
foo/config.yaml YAML configuration file

Alias:

  • teuton n foo
  • teuton -n foo
  • teuton --new foo

4. Check teuton test

teuton check DIRPATH

Description: this command check teuton test and config files located into DIRPATH folder.

Example

Command Description
teuton check path/to/dir/foo Test content of start.rb and config.yaml files.
teuton check path/to/dir/foo --cname=demo Test content of start.rb and demo.yaml files.
teuton check path/to/file/foo.rb Test content of foo.rb and foo.yaml files.
teuton check path/to/file/foo.rb --cname=demo Test content of foo.rb and demo.yaml files.

Alias:

  • teuton c foo
  • teuton -c foo
  • teuton --check foo

5. Run teuton test

teuton run DIRPATH

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

Example

Alias:

  • teuton foo

6. Show README

teuton readme DIRPATH

Read test and config files content, and display information about what kind of problem/exercise it is going to be evaluated. The students need this information to resolv the problem/exercise into their machines.

The teacher could write this information or may use this command to generate automaticaly.

Alias:

  • teuton r DIRPATH
  • teuton -r DIRPATH
  • teuton --readme DIRPATH