gogrlx/docs.grlx.dev
1
0
Fork 0
mirror of https://github.com/gogrlx/docs.grlx.dev.git synced 2026-04-02 03:08:53 -07:00
Code Issues Packages Projects Releases Wiki Activity

update cmd descriptions

Browse Source
This commit is contained in:
Tai Groot
2023-11-14 18:29:23 -08:00
parent 2bd48b516e
commit a02cf6c944
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/content/docs/ingredients/cmd.md
View File

@@ -2,17 +2,17 @@
title: grlx.ingredients.cmd
description: cmd
---
The cmd ingredient allows for us to run arbitrary shell commands against sprouts.
The cmd ingredient allows you to run arbitrary shell commands against sprouts.
## **cmd.run**
Runs shell commands against a sprout
#### Parameters
| parameter | type | required | description |
|-----------|------|----------|-------------|
| _name_ | string | true | the command to run
| _runas_ | string | false | user who will run this command
| _runas_ | string | false | user who will run this command (defaults to root)
| _path_ | string | false | the path to the binary, this is prepended to the name
| _cwd_ | string | false | the directory to run this command
| _env_ | list | false | environmental variables to set like the following: key1=value1
| _env_ | list | false | environment variables to set should be specified like key1=value1
| _timeout_ | string | false | set a timeout for the command using [Go Duration](https://pkg.go.dev/time#ParseDuration)
```yaml
cmd.run: