Table of contents

runShell

Description

Perform a native shell command.

Fields

Field	Type	Description	Default
id	string	Optional. ID of the step.	Generated UUID
description	string	Optional. Description of the step.
action	string	Required. The action to perform.
command	string	Required. Command to perform in the machine’s default shell.
args	array of strings	Optional. Arguments for the command.	`[]`
exitCodes	array of integers	Optional. Expected exit codes of the command. If the command’s actual exit code isn’t in this list, the step fails.	`[0]`
output	string	Optional. Content expected in the command’s output. If the expected content can’t be found in the command’s output (either stdout or stderr), the step fails. Supports strings and regular expressions. To use a regular expression, the string must start and end with a forward slash, like in `/^hello-world.*/`.
setVariables	array of objects	Optional. Extract environment variables from the command’s output.	`[]`
setVariables.name	string	Required. Name of the environment variable to set.
setVariables.regex	string	Required. Regex to extract the environment variable from the command’s output.

Examples

{
  "action": "runShell",
  "command": "echo",
  "args": [
    "$USER"
  ]
}

{
  "action": "runShell",
  "command": "echo",
  "args": [
    "hello-world"
  ],
  "id": "ddec5e20-2e81-4f38-867c-92c8d9516755",
  "description": "This is a test!"
}

{
  "action": "runShell",
  "command": "docker run hello-world",
  "exitCodes": [
    0
  ],
  "output": "Hello from Docker!"
}

{
  "action": "runShell",
  "command": "false",
  "exitCodes": [
    1
  ]
}

{
  "action": "runShell",
  "command": "echo",
  "args": [
    "setup"
  ],
  "exitCodes": [
    0
  ],
  "output": "/.*?/",
  "setVariables": [
    {
      "name": "TEST",
      "regex": ".*"
    }
  ]
}