chore: change tmux module name (#369)

Co-authored-by: 35C4n0r <work.jaykumar@gmail.com>
This commit is contained in:
Ben Potter 2025-08-23 12:16:42 -07:00 committed by GitHub
parent b5837a704d
commit 49ef1203e4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,6 +1,6 @@
--- ---
display_name: "Tmux" display_name: "tmux"
description: "Tmux for coder agent :)" description: "tmux with session persistence and plugins"
icon: "../../../../.icons/tmux.svg" icon: "../../../../.icons/tmux.svg"
verified: false verified: false
tags: ["tmux", "terminal", "persistent"] tags: ["tmux", "terminal", "persistent"]
@ -15,7 +15,7 @@ up a default or custom tmux configuration with session save/restore capabilities
```tf ```tf
module "tmux" { module "tmux" {
source = "registry.coder.com/anomaly/tmux/coder" source = "registry.coder.com/anomaly/tmux/coder"
version = "1.0.0" version = "1.0.1"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
} }
``` ```
@ -39,7 +39,7 @@ module "tmux" {
```tf ```tf
module "tmux" { module "tmux" {
source = "registry.coder.com/anomaly/tmux/coder" source = "registry.coder.com/anomaly/tmux/coder"
version = "1.0.0" version = "1.0.1"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
tmux_config = "" # Optional: custom tmux.conf content tmux_config = "" # Optional: custom tmux.conf content
save_interval = 1 # Optional: save interval in minutes save_interval = 1 # Optional: save interval in minutes
@ -78,7 +78,7 @@ This module can provision multiple tmux sessions, each as a separate app in the
```tf ```tf
module "tmux" { module "tmux" {
source = "registry.coder.com/anomaly/tmux/coder" source = "registry.coder.com/anomaly/tmux/coder"
version = "1.0.0" version = "1.0.1"
agent_id = var.agent_id agent_id = var.agent_id
sessions = ["default", "dev", "anomaly"] sessions = ["default", "dev", "anomaly"]
tmux_config = <<-EOT tmux_config = <<-EOT
@ -91,11 +91,9 @@ module "tmux" {
``` ```
> [!IMPORTANT] > [!IMPORTANT]
> > If you provide a custom `tmux_config`, it will completely replace the default configuration. Ensure you include plugin and TPM initialization lines if you want plugin support and session persistence.
> - If you provide a custom `tmux_config`, it will completely replace the default configuration. Ensure you include plugin > The script will attempt to install dependencies using `sudo` where required.
> and TPM initialization lines if you want plugin support and session persistence. > If `git` is not installed, TPM installation will fail.
> - The script will attempt to install dependencies using `sudo` where required. > If you are using custom config, you'll be responsible for setting up persistence and plugins.
> - If `git` is not installed, TPM installation will fail. > The `order`, `group`, and `icon` variables allow you to customize how tmux apps appear in the Coder UI.
> - If you are using custom config, you'll be responsible for setting up persistence and plugins. > In case of session restart or shh reconnection, the tmux session will be automatically restored :)
> - The `order`, `group`, and `icon` variables allow you to customize how tmux apps appear in the Coder UI.
> - In case of session restart or shh reconnection, the tmux session will be automatically restored :)