Skip to content

docs: add missing actions #264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add missing actions #264

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
216 changes: 196 additions & 20 deletions docs/src/keybindings-possible-actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,41 @@
# Possible Actions

## `BreakPane`

Break out pane to a new tab

**Possible arguments**: None

```javascript
bind "a" { BreakPane; }
```

## `BreakPaneLeft`

Break out pane to the left tab

**Possible arguments**: None

```javascript
bind "a" { BreakPaneLeft; }
```

## `BreakPaneRight`

Break out pane to the right tab

**Possible arguments**: None

```javascript
bind "a" { BreakPaneRight; }
```

## `Clear`

Clear the scrollback buffer of the focused pane

**Possible arguments**: None

eg.
```javascript
bind "a" { Clear; }
```
Expand All @@ -17,7 +46,6 @@ eg.

**Possible arguments**: None

eg.
```javascript
bind "a" { CloseFocus; }
```
Expand All @@ -27,27 +55,66 @@ eg.

**Possible arguments**: None

eg.
```javascript
bind "a" { CloseTab; }
```

## `Confirm`

Confirm a prompt

**Possible arguments**: None

```javascript
bind "a" { Confirm; }
```

## `Copy`

Copy

**Possible arguments**: None

```javascript
bind "a" { Copy; }
```

## `Deny`

Deny a prompt

**Possible arguments**: None

```javascript
bind "a" { Deny; }
```

## `Detach`

Detach from the current session, leaving it running in the background

**Possible arguments**: None

eg.
```javascript
bind "a" { Detach; }
```

## `DumpLayout`

Dump the current layout

**Required arguments**: A path to a file on the hard-drive

```javascript
bind "a" { DumpLayout "/tmp/my-dump.txt"; }
```

## `DumpScreen`

Dump the contents of the focused pane, including its entire scrollback, to the specified file.

**Required arguments**: A path to a file on the hard-drive

eg.
```javascript
bind "a" { DumpScreen "/tmp/my-dump.txt"; }
```
Expand Down Expand Up @@ -130,7 +197,11 @@ eg.

**Required arguments**: The [plugin URL](./plugin-loading.md#plugin-url-schema) (eg. `file:/path/to/my/plugin.wasm`)

**Optional arguments**: `floating` - `true` or `false` (default is `false`)
**Optional arguments**:
- `move_to_focused_tab` (`true/false`): if the plugin is already opened, should it be moved to the focused tab
- `floating` (`true/false`): should it be floating or tiled
- `in_place` (`true/false`): if launching a new plugin, should it be opened in place of the current pane, temporarily suspending it
- `skip_plugin_cache` (`true/false`): if launching a new plugin, force re-compilation (and re-download if the plugin is http)

```javascript
bind "a" {
Expand All @@ -140,20 +211,39 @@ eg.
}
```

## `LaunchPlugin`

Launch a plugin, even if one is already running

**Required arguments**: The [plugin URL](./plugin-loading.md#plugin-url-schema) (eg. `file:/path/to/my/plugin.wasm`)

**Optional arguments**:
- `floating` (`true/false`): should it be floating or tiled
- `in_place` (`true/false`): should it be opened in place of the current pane, temporarily suspending it
- `skip_plugin_cache` (`true/false`): force re-compilation (and re-download if the plugin is http)

```javascript
bind "a" {
LaunchPlugin "zellij:strider" {
floating true
}
}
```

## `MessagePlugin`

Send a message to one or more plugins, using a [pipe](./plugin-pipes.md) - meaning the plugin will be launched if it is not already running.

**Required arguments**: None (with no options specified, this keybind will send an empty message to all plugins)

**Optional arguments:**:
- `launch_new` (`true/false`): force a new plugin to launch even if one is already running
- `skip_cache` (`true/false`): force re-compilation (and re-download if the plugin is http), even if the plugin is already running or cached
- `floating` (`true/false`): if launching a new plugin, should it be floating or tiled
- `name` (`String`): The name of the message
- `payload` (`String`): The payload of the message
- `title` (`String`): The pane title of the pane if launching a new plugin instance
- `cwd` (`String`): The working directory of the plugin if launching a new instance
**Optional arguments**:
- `launch_new` (`true/false`): force a new plugin to launch even if one is already running
- `skip_cache` (`true/false`): force re-compilation (and re-download if the plugin is http), even if the plugin is already running or cached
- `floating` (`true/false`): if launching a new plugin, should it be floating or tiled
- `name` (`String`): name of the message
- `payload` (`String`): payload of the message
- `title` (`String`): pane title of the pane if launching a new plugin instance
- `cwd` (`String`): working directory of the plugin if launching a new instance

```javascript
bind "a" {
Expand Down Expand Up @@ -184,16 +274,27 @@ Send a message to one or more plugins, using a [pipe](./plugin-pipes.md) - meani
```javascript
bind "a" { MoveFocusOrTab "Left"; }
```

## `MovePane`

Move the position of the focused pane in the specific direction
Move the focused pane, optionally in the specific direction

**Required arguments**: `Left` | `Right` | `Up` | `Down`
**Possible arguments**: `Left` | `Right` | `Up` | `Down`

```javascript
bind "a" { MovePane "Left"; }
```

## `MovePaneBackwards`

Move the focused pane backwards

**Possible arguments**: None

```javascript
bind "a" { MovePaneBackwards; }
```

## `MoveTab`

Change the position of the active tab either left or right.
Expand Down Expand Up @@ -228,9 +329,10 @@ Send a message to one or more plugins, using a [pipe](./plugin-pipes.md) - meani

Open a new tab

**Possible arguments**: `cwd`

Current working directory for the new tab, `name` - the name of the new tab, `layout` - path to the layout file to load for this tab
**Possible arguments**:
- `cwd` (`String`): change the working directory of the new tab
- `name` (`String`): name of the new tab
- `layout` (`String`): path to the layout file to load for this tab

```javascript
bind "a" { NewTab; }
Expand All @@ -245,6 +347,17 @@ or:
}
}
```

## `PaneNameInput`

Change pane name

**Required arguments**: `0`

```javascript
bind "a" { PaneNameInput 0; }
```

## `PageScrollDown`

Scroll the focused pane one page down
Expand Down Expand Up @@ -282,6 +395,17 @@ or:
```javascript
bind "a" { Quit; }
```

## `RenameSession`

Rename session

**Required arguments**: New name

```javascript
bind "a" { RenameSession "default"; }
```

## `Resize`

Resize the focused pane either in the specified direction or increase/decrease its size automatically
Expand All @@ -297,7 +421,18 @@ or:

**Required arguments**: The command to run, followed by optional arguments

**Possible arguments**: `cwd` - current working directory, `direction` - the direction to open the new command pane
**Optional arguments**:
- `cwd` (`String`): change the working directory of the new pane
- `name` (`String`): name of the new pane
- `direction` (`String`): direction to open the new pane in
- `close_on_exit` (`true/false`): close the pane immediately when its command exits
- `start_suspended` (`true/false`): Start the command suspended, only running after you first presses ENTER
- `floating` (`true/false`): open the new pane in floating mode
- `in_place` (`true/false`): open the new pane in place of the current pane, temporarily suspending it

**Optional arguments for `floating=true`**:
- `pinned` (`true/false`): whether to pin a floating pane so that it is always on top
- `x`/`y`/`width`/`height`: either a fixed number (characters from screen edge) or a percentage (recommended in case where the terminal window size is not known)

```javascript
// will run "tail -f /tmp/foo" in a pane opened below the focused one
Expand All @@ -308,6 +443,7 @@ or:
}
}
```

## `ScrollDown`

Scroll the focused pane down 1 line
Expand Down Expand Up @@ -354,6 +490,16 @@ or:
bind "a" { Search "up"; }
```

## `SearchInput`

Search for string

**Required arguments**: `0`

```javascript
bind "a" { SearchInput 0; }
```

## `SearchToggleOption`

Toggle various search options on/off
Expand All @@ -364,6 +510,16 @@ or:
bind "a" { SearchToggleOption "CaseSensitivity"; }
```

## `SwitchFocus`

Switch focused pane

**Possible arguments**: None

```javascript
bind "a" { SwitchFocus; }
```

## `SwitchToMode`

Switch the current input mode
Expand All @@ -374,6 +530,16 @@ or:
bind "a" { SwitchToMode "locked"; }
```

## `TabNameInput`

Change tab name

**Required arguments**: `0`

```javascript
bind "a" { TabNameInput 0; }
```

## `ToggleActiveSyncTab`

Toggle the syncing of input between all panes in the focused tab
Expand Down Expand Up @@ -434,6 +600,16 @@ or:
bind "a" { TogglePaneFrames; }
```

## `TogglePanePinned`

Pin/unpin the focused floating pane (pinned floating panes always remain on top)

**Possible arguments**: None

```javascript
bind "a" { TogglePanePinned; }
```

## `ToggleTab`

Change the tab focus
Expand Down