Commands

• command.run

command.run

This is the most basic, but yet powerful action as it can be used to run anything needed that is not directly supported in comtrya by an action. An alias exists, allowing you to abbreviate command as cmd.

The command's output is logged line by line while it runs, visible with -v. Its stdin is empty, so a command that asks a question gets an end of file instead of waiting. A command that fails stops its action with its exit code and what it wrote to stderr, e.g. Command failed with exit code: 1: …; one ended by a signal says so, e.g. Command was killed by signal 9.

Scoped environment variables

Sometimes, environment variables are needed to run a command or set of commands. env sets environment variables for the command of a single command.run action only; comtrya's own environment and later actions don't see them. A PATH in env is also where comtrya looks for the command. Multiple environment variables are supported.

Commands with privileged: true run through sudo (or the configured privilege provider), which usually resets the environment, so env may not reach them.

Writing the output to a file

With stdout, the command's output is written to a file instead of the log, like > in a shell. This is handy for shell completions:

- action: command.run
  command: just
  args:
    - --completions
    - bash
  stdout: "{{ user.home_dir }}/.local/share/bash-completion/completions/just"

• A relative path is relative to dir.
• Missing parent directories are created, and an existing file is overwritten.
• If the command fails, the file is left untouched.
• The file is written by comtrya itself, so with privileged: true it still belongs to the user running comtrya and its directory must be writable by them.

Example

- action: command.run
  dir: .
  command: echo
  args:
  - Hello world

# we should see the GOBIN set in the go env output now
- action: command.run
  command: go
  args:
    - env
  env:
    GOBIN: /Users/test

# GOBIN isn't set here, env only applied to the command above
- action: command.run
  command: go
  args:
    - env