> For the complete documentation index, see [llms.txt](https://docs.rierino.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rierino.com/devops/api-event-and-process-flows/configuring-saga-steps/event-step/core-actions/run-shell-command.md).

# Run Shell Command

## Run Shell Command Actions

### CallShell

Executes given shell command. Event metadata parameters applicable for this action are as follows:

{% tabs %}
{% tab title="Table" %}

| Parameter    | Definition                                                        | Example | Default |
| ------------ | ----------------------------------------------------------------- | ------- | ------- |
| Command      | Main command to execute                                           | ls      | -       |
| Track        | Whether status updates should be recorded in process state or not | true    | false   |
| Parameters   | Arguments to add                                                  | -       | -       |
| {% endtab %} |                                                                   |         |         |

{% tab title="JSON Schema" %}

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "CallShell action eventMeta.parameters",
  "type": "object",
  "properties": {
    "eventMeta": {
      "type": "object",
      "properties": {
        "parameters": {
          "type": "object",
          "properties": {
            "command": {
              "type": "string",
              "definition": "Main command to execute",
              "example": "ls"
            },
            "track": {
              "type": "boolean",
              "definition": "Whether status updates should be recorded in process state or not",
              "default": false,
              "example": true
            }
          },
          "patternProperties": {
            "^param_\\\\[\\\\d+\\\\]_arg$": {
              "type": "string",
              "definition": "Name of the ith argument to add",
              "example": "--dir"
            },
            "^param_\\\\[\\\\d+\\\\]_value$": {
              "type": "string",
              "definition": "Value of the ith argument to add",
              "example": "/tmp"
            },
            "^param_\\\\[\\\\d+\\\\]_path$": {
              "type": "string",
              "definition": "Path from input payload for ith argument",
              "example": "parameters.dir"
            },
            "^param_\\\\[\\\\d+\\\\]_asText$": {
              "type": "boolean",
              "definition": "Whether payload value should be added as text",
              "default": false,
              "example": true
            },
            "^param_\\\\[\\\\d+\\\\]_repeat$": {
              "type": "boolean",
              "definition": "Whether array or object payload values should repeat argument",
              "default": false,
              "example": true
            },
            "^param_\\\\[\\\\d+\\\\]_delimiter$": {
              "type": "string",
              "definition": "Delimiter to put between array or object payload values if argument won't be repeated",
              "example": ","
            },
            "^param_\\\\[\\\\d+\\\\]_separator$": {
              "type": "string",
              "definition": "Separator to put between argument and object values if argument will be repeated",
              "example": "="
            }
          }
        }
      }
    }
  }
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.rierino.com/devops/api-event-and-process-flows/configuring-saga-steps/event-step/core-actions/run-shell-command.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.