- 1. Introduction
- 1.1. Installation
- 1.2. Integration
- 1.3. FAQ
- 2. Commands
- 3. Rebinding Keys
- 3.1. Keybinding Presets
- 3.2. Changing Modifiers
- 4. Configuration
- 4.1. Options
- 4.2. Keybindings
- 4.2.1. Modes
- 4.2.2. Binding and Overriding Keys
- 4.2.3. Keys
- 4.2.4. Possible Actions
- 4.2.5. Shared Bindings
- 4.3. Themes
- 4.3.1. List of Themes
- 4.3.2. Legacy Themes
- 4.4. CLI Configuration
- 4.5. Migrating from old YAML config files
- 5. Controlling Zellij through the CLI
- 5.1. Zellij Run
- 5.2. Zellij Edit
- 5.3. Zellij Action
- 5.4. Zellij Plugin
- 5.5. Zellij Pipe
- 6. Layouts
- 6.1. Creating a Layout
- 6.1.1. Swap Layouts
- 6.2. Including Configuration in Layouts
- 6.3. Examples
- 6.4. Migrating from old YAML layouts
- 7. Plugins
- 7.1. Status of the Plugin System
- 7.2. Loading Plugins
- 7.3. Plugin API
- 7.3.1. Events
- 7.3.2. Commands
- 7.3.3. Permissions
- 7.3.4. Configuration
- 7.3.5. Reading from the Filesystem
- 7.3.6. Logging
- 7.3.7. Workers for Async Tasks
- 7.3.8. Pipes for communicating with and between plugins
- 7.4. Developing a Plugin
- 7.4.1. Development Environment
- 7.4.2. Plugin Lifecycle
- 7.4.3. Rendering a UI
- 7.4.4. Upgrading and Backwards Compatibility
- 7.5. Plugin Aliases
- 7.5.1. The tab-bar alias
- 7.5.2. The status-bar alias
- 7.5.3. The strider alias
- 7.5.4. The compact-bar alias
- 7.5.5. The session-manager alias
- 7.5.6. The welcome-screen alias
- 7.5.7. The filepicker alias
- 7.6. Example Plugins
- 7.7. Developing a Plugin in Other Languages
- 7.8. Plugin Upgrade Guide for version 0.38.0
- 8. Session Resurrection
- 9. Compatibility