Skip to content

Commit 626a0cc

Browse files
committed
Update Attyx docs to the lates version
1 parent 92584c7 commit 626a0cc

9 files changed

Lines changed: 191 additions & 18 deletions

File tree

src/content/docs/docs/attyx/cli.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Commands are used without `--`. For example: `attyx kill-daemon`.
3030
| `--rows <N>` | Terminal rows (default: 24) |
3131
| `--cols <N>` | Terminal columns (default: 80) |
3232
| `--cmd <command...>` | Override shell command |
33+
| `-d`, `--working-directory <path>` | Set initial working directory |
3334

3435
## Config
3536

@@ -93,12 +94,19 @@ Commands are used without `--`. For example: `attyx kill-daemon`.
9394
| Shortcut | Action |
9495
|----------|--------|
9596
| **Ctrl+Shift+R** | Reload config |
96-
| **Ctrl+F** | Open in-terminal search |
97+
| **Cmd+,** / **Ctrl+,** | Open config file |
98+
| **Cmd+F** / **Ctrl+F** | Open in-terminal search |
9799
| **Cmd+Shift+P** / **Ctrl+Shift+P** | Command palette |
98100
| **Ctrl+Shift+Space** | Visual mode (copy mode) |
101+
| **Cmd+K** / **Ctrl+Shift+K** | Clear screen and scrollback |
99102
| **Ctrl+Shift+N** | New session |
100103
| **Ctrl+Shift+S** | Session picker |
101104
| **Cmd+T** / **Ctrl+Shift+T** | New tab |
102105
| **Cmd+W** / **Ctrl+Shift+W** | Close tab |
103106
| **Ctrl+Tab** | Next tab |
104107
| **Ctrl+Shift+Tab** | Previous tab |
108+
| **Cmd+D** / **Ctrl+Shift+D** | Split vertically |
109+
| **Cmd+Shift+D** / **Ctrl+Shift+E** | Split horizontally |
110+
| **Cmd+=** / **Ctrl+=** | Increase font size |
111+
| **Cmd+-** / **Ctrl+-** | Decrease font size |
112+
| **Cmd+0** / **Ctrl+0** | Reset font size |

src/content/docs/docs/attyx/configuration.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ args = ["-l"]
9191
|--------|------|---------|-------------|
9292
| `shell` | string | `$SHELL` or `/bin/sh` | Shell program to run |
9393
| `args` | string[] | `[]` | Extra arguments passed to the shell |
94+
| `working_directory` | string || Initial working directory |
9495

9596
## Logging
9697

@@ -186,10 +187,32 @@ enabled = true
186187

187188
See the [Sessions docs](/docs/attyx/sessions/) for session picker icon customization.
188189

190+
## Splits
191+
192+
```toml
193+
[splits]
194+
resize_step = 4
195+
```
196+
197+
| Option | Type | Default | Description |
198+
|--------|------|---------|-------------|
199+
| `resize_step` | integer | `4` | Number of cells to resize panes by (1–50) |
200+
201+
## Updates
202+
203+
```toml
204+
[updates]
205+
check_updates = true
206+
```
207+
208+
| Option | Type | Default | Description |
209+
|--------|------|---------|-------------|
210+
| `check_updates` | boolean | `true` | Enable automatic update checking |
211+
189212
## Hot Reload
190213

191214
Send `SIGUSR1` or press **Ctrl+Shift+R** to reload the config at runtime.
192215

193-
**Reloads immediately:** cursor shape, cursor blink, scrollback lines, font family, font size, cell width, cell height, status bar settings, tab appearance
216+
**Reloads immediately:** cursor shape, cursor blink, cursor trail, scrollback lines, font family, font size, cell width, cell height, status bar settings, tab appearance, theme, keybindings, splits, popups
194217

195-
**Requires restart:** background opacity, background blur, logging level, logging file
218+
**Requires restart:** background opacity, background blur, logging level, logging file, program settings, updates

src/content/docs/docs/attyx/keybindings.md

Lines changed: 46 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,10 @@ scroll_page_down = "shift+page_down"
1919
scroll_to_top = "shift+home"
2020
scroll_to_bottom = "shift+end"
2121
config_reload = "ctrl+shift+r"
22-
new_window = "ctrl+shift+n"
2322
close_window = "ctrl+shift+w"
23+
split_vertical = "ctrl+shift+d"
24+
pane_focus_up = "ctrl+k"
25+
clear_screen = "ctrl+shift+k"
2426
```
2527

2628
## Disabling a keybinding
@@ -55,8 +57,9 @@ alt+enter
5557
| Action | macOS | Linux |
5658
|---|---|---|
5759
| `config_reload` | `ctrl+shift+r` | `ctrl+shift+r` |
58-
| `command_palette` | `super+shift+p` | `ctrl+shift+p` |
59-
| `new_window` | `ctrl+shift+n` | `ctrl+shift+n` |
60+
| `command_palette_toggle` | `super+shift+p` | `ctrl+shift+p` |
61+
| `open_config` | `super+,` | `ctrl+,` |
62+
| `clear_screen` | `super+k` | `ctrl+shift+k` |
6063
| `close_window` | `ctrl+shift+w` | `ctrl+shift+w` |
6164

6265
### Search
@@ -88,15 +91,48 @@ alt+enter
8891

8992
| Action | macOS | Linux |
9093
|---|---|---|
91-
| `new_tab` | `super+t` | `ctrl+shift+t` |
92-
| `close_tab` | `super+w` | `ctrl+shift+w` |
93-
| `next_tab` | `ctrl+tab` | `ctrl+tab` |
94-
| `prev_tab` | `ctrl+shift+tab` | `ctrl+shift+tab` |
95-
| `tab_1``tab_9` | `super+1``super+9` | `alt+1``alt+9` |
94+
| `tab_new` | `super+t` | `ctrl+shift+t` |
95+
| `tab_close` | `super+w` | `ctrl+shift+w` |
96+
| `tab_next` | `ctrl+tab` | `ctrl+tab` |
97+
| `tab_prev` | `ctrl+shift+tab` | `ctrl+shift+tab` |
98+
| `tab_select_1``tab_select_9` | `super+1``super+9` | `alt+1``alt+9` |
99+
| `tab_next_arrows` | `super+shift+right` | `ctrl+alt+right` |
100+
| `tab_prev_arrows` | `super+shift+left` | `ctrl+alt+left` |
101+
| `tab_move_left` | `super+ctrl+shift+left` | `ctrl+alt+shift+left` |
102+
| `tab_move_right` | `super+ctrl+shift+right` | `ctrl+alt+shift+right` |
103+
104+
### Splits / Panes
105+
106+
| Action | macOS | Linux |
107+
|---|---|---|
108+
| `split_vertical` | `super+d` | `ctrl+shift+d` |
109+
| `split_horizontal` | `super+shift+d` | `ctrl+shift+e` |
110+
| `pane_close` | `super+shift+w` | `ctrl+shift+q` |
111+
| `pane_focus_up` | `ctrl+k` | `ctrl+k` |
112+
| `pane_focus_down` | `ctrl+j` | `ctrl+j` |
113+
| `pane_focus_left` | `ctrl+h` | `ctrl+h` |
114+
| `pane_focus_right` | `ctrl+l` | `ctrl+l` |
115+
| `pane_resize_up` | `super+ctrl+k` | `ctrl+alt+k` |
116+
| `pane_resize_down` | `super+ctrl+j` | `ctrl+alt+j` |
117+
| `pane_resize_left` | `super+ctrl+h` | `ctrl+alt+h` |
118+
| `pane_resize_right` | `super+ctrl+l` | `ctrl+alt+l` |
119+
| `pane_resize_grow` | `super+ctrl+=` | `ctrl+alt+=` |
120+
| `pane_resize_shrink` | `super+ctrl+-` | `ctrl+alt+-` |
121+
| `pane_rotate` | `ctrl+shift+o` | `ctrl+shift+o` |
122+
| `pane_zoom_toggle` | `super+shift+z` | `ctrl+shift+z` |
96123

97124
### Sessions
98125

99126
| Action | macOS | Linux |
100127
|---|---|---|
101-
| `session_new` | `super+shift+n` | `ctrl+shift+n` |
102-
| `session_picker` | `super+shift+s` | `ctrl+shift+s` |
128+
| `session_create` | `ctrl+shift+n` | `ctrl+shift+n` |
129+
| `session_switcher_toggle` | `ctrl+shift+s` | `ctrl+shift+s` |
130+
| `session_kill` | `ctrl+d` | `ctrl+d` |
131+
132+
### Font Size
133+
134+
| Action | macOS | Linux |
135+
|---|---|---|
136+
| `font_size_increase` | `super+=` | `ctrl+=` |
137+
| `font_size_decrease` | `super+-` | `ctrl+-` |
138+
| `font_size_reset` | `super+0` | `ctrl+0` |

src/content/docs/docs/attyx/popups.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ padding = 1
4242
| `border` | `"single"` | Border style: `single`, `double`, `rounded`, `heavy`, or `none` |
4343
| `border_color` | `"#78829a"` | Border foreground color (`#RRGGBB`) |
4444
| `on_return_cmd` | *(none)* | Command to run with the popup's captured stdout when it exits successfully (exit code 0) |
45+
| `inject_alt` | `false` | When true, `on_return_cmd` is injected into the PTY even when an alt screen is active. When false, it runs as a detached process instead. |
4546
| `background_opacity` | *(none)* | Background opacity from `0.0` (transparent) to `1.0` (opaque) |
4647
| `background` | *(theme)* | Background color override (`#RRGGBB`). Empty or omitted = use theme background |
4748
| `padding` | *(none)* | Inner padding on all sides (cells) |

src/content/docs/docs/attyx/sessions.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,12 @@ Sessions are sorted with the current session first, then other active sessions,
2727
| `Enter` | Switch to the selected session (or restore a recent one) |
2828
| `Ctrl+R` | Rename the selected session |
2929
| `Ctrl+X` | Kill the selected session (with confirmation) |
30+
| `Ctrl+D` | Switch to default session |
31+
| `Ctrl+U` | Clear filter |
32+
| `Ctrl+W` | Delete word backward |
33+
| `Ctrl+A` | Jump to start of filter |
34+
| `Ctrl+E` | Jump to end of filter |
35+
| `Ctrl+K` | Kill to end of line |
3036
| `Escape` | Close the picker |
3137

3238
## Configuration

src/content/docs/docs/attyx/status-bar.md

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ truncate = 2 # show only the last 2 path components
4040

4141
### Git
4242

43-
Shows the current branch name and working tree status.
43+
Shows the current branch name and working tree status — staged, modified, untracked, conflicts, stash count, and line statistics.
4444

4545
```toml
4646
[statusbar.git]
@@ -49,6 +49,53 @@ side = "left"
4949

5050
The git widget reacts to directory changes automatically — when you `cd` into a different repo, it updates immediately.
5151

52+
#### Customizing icons
53+
54+
Every field in the git widget has a configurable icon:
55+
56+
| Option | Default | Description |
57+
|--------|---------|-------------|
58+
| `icon_branch` | `"⎇ "` | Branch name prefix |
59+
| `icon_hashprefix` | `"#"` | Detached HEAD commit hash prefix |
60+
| `icon_ahead` | `"↑·"` | Commits ahead of remote |
61+
| `icon_behind` | `"↓·"` | Commits behind remote |
62+
| `icon_staged` | `"● "` | Staged changes |
63+
| `icon_modified` | `"✚ "` | Modified files |
64+
| `icon_untracked` | `"… "` | Untracked files |
65+
| `icon_conflict` | `"✖ "` | Merge conflicts |
66+
| `icon_stashed` | `"⚑ "` | Stashed items |
67+
| `icon_clean` | `" ✔"` | Clean working tree |
68+
| `icon_insertions` | `"+"` | Line insertions |
69+
| `icon_deletions` | `"-"` | Line deletions |
70+
71+
#### Customizing colors
72+
73+
Each field can also have a custom color (`#RRGGBB`). When omitted, the theme's ANSI palette is used.
74+
75+
| Option | Description |
76+
|--------|-------------|
77+
| `color_staged` | Staged changes color |
78+
| `color_modified` | Modified files color |
79+
| `color_untracked` | Untracked files color |
80+
| `color_conflict` | Conflicts color |
81+
| `color_stashed` | Stash count color |
82+
| `color_ahead` | Ahead count color |
83+
| `color_behind` | Behind count color |
84+
| `color_clean` | Clean indicator color |
85+
| `color_insertions` | Insertions count color |
86+
| `color_deletions` | Deletions count color |
87+
88+
#### Example
89+
90+
```toml
91+
[statusbar.git]
92+
side = "left"
93+
icon_branch = " "
94+
icon_clean = ""
95+
color_staged = "#a6e3a1"
96+
color_conflict = "#f38ba8"
97+
```
98+
5299
### Time
53100

54101
Displays the current time.

src/content/docs/docs/attyx/themes.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,30 @@ Attyx ships with built-in themes and supports custom TOML theme files.
99

1010
## Built-in themes
1111

12-
- `default`
12+
Attyx ships with 22 built-in themes:
13+
14+
- `catppuccin-latte`
1315
- `catppuccin-mocha`
16+
- `default`
17+
- `dracula`
18+
- `everforest-dark`
19+
- `github-dark`
20+
- `gruvbox-dark`
21+
- `gruvbox-light`
22+
- `iceberg`
23+
- `kanagawa`
24+
- `material`
25+
- `monokai`
26+
- `nord`
27+
- `one-dark`
28+
- `palenight`
29+
- `rose-pine`
30+
- `rose-pine-moon`
31+
- `snazzy`
32+
- `solarized-dark`
33+
- `solarized-light`
34+
- `tokyo-night`
35+
- `tokyo-night-storm`
1436

1537
Set the theme in your config:
1638

src/content/docs/docs/attyx/visual-mode.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ Press `Ctrl+Shift+Space` to enter copy mode. You'll see a cursor you can move ar
2121
| `l` / `Right` | Move right |
2222
| `w` | Jump forward one word |
2323
| `b` | Jump backward one word |
24+
| `e` | Jump to end of word |
2425
| `0` | Jump to start of line |
26+
| `^` | Jump to first non-blank character |
2527
| `$` | Jump to end of line |
2628
| `g` | Jump to top of scrollback |
2729
| `G` | Jump to bottom |
@@ -40,6 +42,15 @@ From copy mode, press one of these to start selecting:
4042

4143
Move the cursor to extend your selection, then press `y` to copy it to the clipboard.
4244

45+
## Text objects
46+
47+
While in a selection mode, you can use text object modifiers:
48+
49+
| Key | Action |
50+
|-----|--------|
51+
| `i` + object | Select inner text object (e.g. `iw` for inner word, `i"` for inner quotes) |
52+
| `a` + object | Select around text object (e.g. `aw` for word + surrounding space) |
53+
4354
## In-terminal search
4455

4556
While in copy mode, you can search the scrollback:

src/content/docs/docs/attyx/vt-compatibility.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,19 +69,38 @@ Attyx implements a comprehensive set of VT/ANSI escape sequences.
6969

7070
| Sequence | Description |
7171
|----------|-------------|
72-
| ESC[?1049h/l | Alternate screen buffer |
73-
| ESC[?2004h/l | Bracketed paste mode |
72+
| ESC[?1h/l | DECCKM — application/normal cursor keys |
73+
| ESC[?7h/l | Auto-wrap mode |
74+
| ESC[?25h/l | Cursor visibility |
75+
| ESC[?47h/l | Alternate screen buffer (47) |
7476
| ESC[?1000h/l | Mouse tracking (X10) |
77+
| ESC[?1002h/l | Mouse tracking (button-event) |
78+
| ESC[?1003h/l | Mouse tracking (any-event) |
7579
| ESC[?1006h/l | SGR mouse encoding |
80+
| ESC[?1047h/l | Alternate screen buffer (1047) |
81+
| ESC[?1049h/l | Alternate screen buffer (1049) |
82+
| ESC[?2004h/l | Bracketed paste mode |
7683
| ESC[?2026h/l | Synchronized output |
77-
| ESC[?25h/l | Cursor visibility |
7884

7985
## OSC Sequences
8086

8187
| Sequence | Description |
8288
|----------|-------------|
8389
| OSC 0/2 | Set terminal title |
90+
| OSC 4 | Query palette color |
91+
| OSC 7 | Set working directory |
8492
| OSC 8 | Hyperlinks (clickable URLs) |
93+
| OSC 9 | Desktop notification (iTerm2 style) |
94+
| OSC 10 | Query/set foreground color |
95+
| OSC 11 | Query/set background color |
96+
| OSC 12 | Query/set cursor color |
97+
| OSC 777 | Desktop notification (rxvt/Kitty style) |
98+
99+
## DCS Sequences
100+
101+
| Sequence | Description |
102+
|----------|-------------|
103+
| DCS ... ST | DCS passthrough |
85104

86105
## Kitty Protocols
87106

0 commit comments

Comments
 (0)