Skip to content

Commit 0f4ba58

Browse files
committed
clean up
1 parent 3713131 commit 0f4ba58

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

website/docs/cli/commands/list/usage.mdx

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,9 @@ The `value` field in each column definition supports Go templates. The available
8484

8585
### For `atmos list workflows`:
8686
```yaml
87-
{{ .workflow_file }} # The filename containing the workflow definition
88-
{{ .workflow_name }} # The name of the workflow
89-
{{ .workflow_description }} # The description provided for the workflow
87+
{{ .name }} # The name of the workflow
88+
{{ .file }} # The manifest name
89+
{{ .description }} # The description provided for the workflow
9090
```
9191

9292
### For `atmos list values`, `atmos list vars`, `atmos list settings`, and `atmos list metadata`:
@@ -114,6 +114,25 @@ Here's the general structure for defining custom list columns in `atmos.yaml`:
114114
- Replace `<command_scope>` with the specific scope corresponding to the `atmos list` command you want to customize (e.g., `stacks` for `atmos list stacks`).
115115
- The `columns` array is mandatory if you want to override the default columns. If `columns` is omitted, the command uses its default output columns.
116116

117+
### Custom Columns for Workflows
118+
119+
```yaml
120+
# In atmos.yaml
121+
workflows:
122+
list:
123+
columns:
124+
- name: Workflow
125+
value: "{{ .name }}" # Corresponds to the workflow key in the manifest
126+
- name: Manifest Name
127+
value: "{{ .file }}" # Corresponds to the 'name' field within the manifest file
128+
- name: Description
129+
value: "{{ .description }}" # Corresponds to the 'description' field for the workflow
130+
```
131+
132+
:::info
133+
Note that `{{ .file }}` in this context refers to the value of the top-level `name` attribute within the workflow manifest file itself, not the path to the file.
134+
:::
135+
117136

118137
## Display Behavior
119138

0 commit comments

Comments
 (0)