You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: registry/coder/modules/goose/README.md
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,14 +24,14 @@ module "goose" {
24
24
25
25
## Prerequisites
26
26
27
-
-`screen` must be installed in your workspace to run Goose in the background
27
+
-`screen`or `tmux`must be installed in your workspace to run Goose in the background
28
28
- You must add the [Coder Login](https://registry.coder.com/modules/coder-login) module to your template
29
29
30
30
The `codercom/oss-dogfood:latest` container image can be used for testing on container-based workspaces.
31
31
32
32
## Examples
33
33
34
-
Your workspace must have `screen` installed to use this.
34
+
Your workspace must have `screen`or `tmux`installed to use the background session functionality.
35
35
36
36
### Run in the background and report tasks (Experimental)
37
37
@@ -99,8 +99,12 @@ module "goose" {
99
99
# Enable experimental features
100
100
experiment_report_tasks = true
101
101
102
-
# Run Goose in the background
102
+
# Run Goose in the background with screen (pick one: screen or tmux)
103
103
experiment_use_screen = true
104
+
# experiment_use_tmux = true # Alternative: use tmux instead of screen
105
+
106
+
# Optional: customize the session name (defaults to "goose")
107
+
# session_name = "goose-session"
104
108
105
109
# Avoid configuring Goose manually
106
110
experiment_auto_configure = true
@@ -143,7 +147,7 @@ Note: The indentation in the heredoc is preserved, so you can write the YAML nat
143
147
144
148
## Run standalone
145
149
146
-
Run Goose as a standalone app in your workspace. This will install Goose and run it directly without using screen or any task reporting to the Coder UI.
150
+
Run Goose as a standalone app in your workspace. This will install Goose and run it directly without using screen or tmux, and without any task reporting to the Coder UI.
0 commit comments