Skip to content

Commit 5af7e66

Browse files
docs(goose): update README to include tmux as an alternative to screen and session name variable
1 parent 670f997 commit 5af7e66

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

registry/coder/modules/goose/README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ module "goose" {
2424

2525
## Prerequisites
2626

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
2828
- You must add the [Coder Login](https://registry.coder.com/modules/coder-login) module to your template
2929

3030
The `codercom/oss-dogfood:latest` container image can be used for testing on container-based workspaces.
3131

3232
## Examples
3333

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.
3535

3636
### Run in the background and report tasks (Experimental)
3737

@@ -99,8 +99,12 @@ module "goose" {
9999
# Enable experimental features
100100
experiment_report_tasks = true
101101
102-
# Run Goose in the background
102+
# Run Goose in the background with screen (pick one: screen or tmux)
103103
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"
104108
105109
# Avoid configuring Goose manually
106110
experiment_auto_configure = true
@@ -143,7 +147,7 @@ Note: The indentation in the heredoc is preserved, so you can write the YAML nat
143147

144148
## Run standalone
145149

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.
147151

148152
```tf
149153
module "goose" {

0 commit comments

Comments
 (0)