When you create a job application using the Runly.JobHost, it provides a standard CLI for your application.

List

Lists the jobs found at startup, including the assembly where the job is located, its config type and the default config (output as JSON even when the -j switch is not specified). If there are errors with the job these will be listed instead of the config in the default output format.

Usage:

MyApp list [-v] [-j]
dotnet run -- list [-v] [-j]

Parameters:

  • -v (verbose) - Optional. Changes the config serialization to include all properties.
  • -j (json) - Optional. Changes the output format to JSON.

Get

Gets the default config for the job type specified.

Usage:

MyApp get JobType [FilePath] [-v]
dotnet run -- get JobType [FilePath] [-v]

Parameters:

  • JobType - Required. The job type to get the default config for. Can be either fully qualified with the type’s namespace or the type name by itself. Not case sensitive.
  • FilePath - Optional. Writes the output of the command to the file path specified instead of the standard output, overwriting the file if it exists. If an existing directory path is specified, a JSON file with the job type name will be written to the directory.
  • -v (verbose) - Optional. Changes the config serialization to include all properties.

Run

Runs a job using the supplied config file.

Usage:

MyApp run ConfigPath [ResultsPath] [-s] [-d]
dotnet run -- run ConfigPath [ResultsPath] [-s] [-d]

Parameters:

  • ConfigPath - Required. The serialized config for the job to run.
  • ResultsPath - Optional. The file path to write the results of the job to. Overrides Execution.ResultsFilePath and sets Execution.ResultsToFile to true.
  • -s (silent) - Optional. Silences console output. Overrides Config.Execution.OutputToConsole, setting it to false.
  • -d (debug) - Optional. Prompts the user to attach a debugger when the job starts.