Skip to content

Commit d9f8c95

Browse files
committed
feat: update readme
1 parent 26e4c12 commit d9f8c95

File tree

1 file changed

+9
-22
lines changed

1 file changed

+9
-22
lines changed

registry/anomaly/modules/tmux/README.md

Lines changed: 9 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ verified: false
66
tags: ["tmux", "terminal", "persistent"]
77
---
88

9-
# tmux Terraform Module
9+
# tmux
1010

1111
This module provisions and configures [tmux](https://github.com/tmux/tmux) with session persistence and plugin support
1212
for a Coder agent. It automatically installs tmux, the Tmux Plugin Manager (TPM), and a set of useful plugins, and sets
@@ -28,7 +28,7 @@ up a default or custom tmux configuration with session save/restore capabilities
2828

2929
## Usage
3030

31-
```hcl
31+
```tf
3232
module "tmux" {
3333
source = "path/to/this/module"
3434
agent_id = coder_agent.example.id
@@ -37,14 +37,6 @@ module "tmux" {
3737
}
3838
```
3939

40-
## Input Variables
41-
42-
| Name | Type | Description | Default |
43-
| ------------- | ------ | ----------------------------------- | ------- |
44-
| agent_id | string | The ID of a Coder agent. | n/a |
45-
| tmux_config | string | Custom tmux configuration to apply. | "" |
46-
| save_interval | number | Save interval (in minutes). | 1 |
47-
4840
## How It Works
4941

5042
- **tmux Installation:**
@@ -64,7 +56,7 @@ module "tmux" {
6456

6557
## Example
6658

67-
```hcl
59+
```tf
6860
module "tmux" {
6961
source = "./registry/anomaly/modules/tmux"
7062
agent_id = var.agent_id
@@ -75,15 +67,10 @@ module "tmux" {
7567
}
7668
```
7769

78-
## Outputs
79-
80-
This module does not export outputs.
81-
82-
## Notes
83-
84-
- If you provide a custom `tmux_config`, it will completely replace the default configuration. Ensure you include plugin
70+
> [!NOTE]
71+
> - If you provide a custom `tmux_config`, it will completely replace the default configuration. Ensure you include plugin
8572
and TPM initialization lines if you want plugin support.
86-
- The script will attempt to install dependencies using `sudo` where required.
87-
- If `git` is not installed, TPM installation will fail.
88-
- To restore in case of server restart `prefix + ctrl+r`
89-
- If you are using custom config, you'll be responsible for setting up persistence
73+
> - The script will attempt to install dependencies using `sudo` where required.
74+
> - If `git` is not installed, TPM installation will fail.
75+
> - To restore in case of server restart `prefix + ctrl+r`
76+
> - If you are using custom config, you'll be responsible for setting up persistence

0 commit comments

Comments
 (0)