Skip to content

General Usage

Parker Johansen edited this page Oct 18, 2019 · 3 revisions

Glotter is an execution library for collections of single file scripts. It uses Docker to be able to build and run scripts in any language without having to install a local sdk or development environment.

Before Glotter can be used, your project must be configured. See Integrating with Glotter for more information

The Glotter CLI has three main parts:

  • Download
  • Run
  • Test

While these each perform a different function (described below), they all take the same optional arguments:

Flag Short Flag Description
--help -h print help text and exit
--source -s perform action using a single source file
--project -p perform action using all sources relevant to a certain project key
--language -l perform action using all sources of a given language

Download

Download is used to download any required docker images. It is invoked using glotter download with any of the flags described above.

It is not necessary to invoke download manually before run or test. It will be invoked automatically. This command is exposed for convenience in cases where you want to have everything you will need downloaded ahead of time.

Run

Run is used to execute scripts. It is invoked using glotter run with any of the flags described above. If a script requires input, it will prompt for that information.

Test

Test is used to execute tests for scripts. It is invoked using glotter test with any of the flags described above.

Clone this wiki locally