# System

The `system` operator allows you to run an external command and use its output as a value in your expression.

**Security warning**: The system operator is disabled by default. You must explicitly pass `--security-enable-system-operator` to use it.

**Note:** When enabled, the system operator can replicate the functionality of `env` and `load` operators via external commands. Enabling it effectively overrides `--security-disable-env-ops` and `--security-disable-file-ops`.

## Usage

```bash
yq --security-enable-system-operator --null-input '.field = system("command"; "arg1")'
```

The operator takes:

* A command string (required)
* An argument (or an array of arguments), separated from the command by `;` (optional)

The current matched node's value is serialised and piped to the command via stdin. The command's stdout (with trailing newline stripped) is returned as a string.

## Disabling the system operator

The system operator is disabled by default. When disabled, an error is returned instead of running the command, consistent with `--security-disable-env-ops` and `--security-disable-file-ops`.

Use `--security-enable-system-operator` flag to enable it.

## system operator returns error when disabled

Use `--security-enable-system-operator` to enable the system operator.

Given a sample.yml file of:

```yaml
country: Australia
```

then

```bash
yq '.country = system("/usr/bin/echo"; "test")' sample.yml
```

will output

```bash
Error: system operations are disabled, use --security-enable-system-operator to enable
```

## Run a command with an argument

Use `--security-enable-system-operator` to enable the system operator.

Given a sample.yml file of:

```yaml
country: Australia
```

then

```bash
yq --security-enable-system-operator '.country = system("/usr/bin/echo"; "test")' sample.yml
```

will output

```yaml
country: test
```

## Run a command without arguments

Omit the semicolon and args to run the command with no extra arguments.

Given a sample.yml file of:

```yaml
a: hello
```

then

```bash
yq --security-enable-system-operator '.a = system("/usr/bin/echo")' sample.yml
```

will output

```yaml
a: ""
```


---

# Agent Instructions: 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:

```
GET https://mikefarah.gitbook.io/yq/operators/system-operators.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.