How zellij-org/zellij works
Zellij is a terminal workspace and multiplexer. A user starts or joins a session, interacts through a local terminal or built-in web client, and uses server-managed tabs and panes to run terminal programs and plugins. The map preserves documented layouts, collaboration, floating/stacked panes, and plugin capabilities. Source-index references support several internal links; broader product relationships are cited to the README. Many subsystems are unsampled, so their internal wiring is not asserted.
Main entry points: screen.rs Session server · lib.rs Terminal client · main.rs Workspace bars · connection_manager.rs Web client
Components 27
Entry and clients
- CLI startup
src/lib.rs - Terminal client
zellij-client/src/lib.rs - OS I/O
zellij-client/src/os_input_output.rs - Web client
zellij-client/src/web_client/connection_manager.rs
Session runtime
- Session server
zellij-server/src/screen.rs - PTY processes
zellij-server/src/pty.rs - Pane management
zellij-server/src/panes/mod.rs - Tab interactions
zellij-server/src/tab/mouse_handler.rs - Layout parsing
zellij-utils/src/kdl/kdl_layout_parser.rs
Terminal capabilities
- Terminal emulation
zellij-terminal/src/session/client_loop.rs - Attention policy
zellij-terminal/src/app/policy/engine.rs
Built-in plugins
- Workspace bars
default-plugins/bars/src/main.rs - Bar actions
default-plugins/bars/src/click_actions.rs - Tab dragging
default-plugins/bars/src/tab_drag.rs - Configuration UI
default-plugins/configuration/src/main.rs - Settings editor
default-plugins/configuration/src/list_editor.rs - About and onboarding
default-plugins/about/src/main.rs - About pages
default-plugins/about/src/pages.rs - Interactive components
default-plugins/about/src/active_component.rs - Session manager
default-plugins/session-manager/src/main.rs - Prompt plugin
default-plugins/prompt/src/app.rs - Sharing plugin
default-plugins/share/src/main.rs - File browser
default-plugins/strider/src/main.rs
Shared contracts
- Web messages
zellij-client/src/web_client/control_message.rs - Client-server protocol
zellij-utils/src/client_server_contract/client_to_server.proto - Plugin API
zellij-tile/src/lib.rs
Other components
- User
Connections 28
- User → CLI startup: starts or joins
README.md - CLI startup → Terminal client: launches
- Terminal client → OS I/O: uses
zellij-client/src/lib.rs - Terminal client → Session server: connects to
- Web client → Session server: collaborates with
README.md - Web client → Web messages: uses messages
zellij-client/src/web_client/connection_manager.rs - Terminal client → Client-server protocol: exchanges protocol
- Session server → Client-server protocol: exchanges protocol
- Session server → Pane management: manages
zellij-server/src/tab/mouse_handler.rs - Session server → PTY processes: manages processes
- Session server → Layout parsing: applies layouts
README.md - Session server → Terminal emulation: serves terminal sessions
README.md - Pane management → Tab interactions: handles interactions
zellij-server/src/tab/mouse_handler.rs - Terminal emulation → Attention policy: evaluates attention
- Session server → Workspace bars: hosts plugin UI
README.md - Workspace bars → Bar actions: dispatches actions
default-plugins/bars/src/main.rs - Workspace bars → Tab dragging: delegates dragging
default-plugins/bars/src/main.rs - Session server → Configuration UI: hosts plugin UI
README.md - Configuration UI → Settings editor: uses editor
default-plugins/configuration/src/main.rs - Session server → About and onboarding: hosts plugin UI
README.md - About and onboarding → About pages: renders pages
default-plugins/about/src/main.rs - About pages → Interactive components: uses components
default-plugins/about/src/pages.rs - Session server → Session manager: hosts plugin UI
README.md - Session server → Prompt plugin: hosts plugin UI
README.md - Session server → Sharing plugin: hosts plugin UI
README.md - Session server → File browser: hosts plugin UI
README.md - Plugin API → Workspace bars: supports plugins
README.md - Plugin API → Session manager: supports plugins
README.md