A terminal workspace with batteries included | patched for cargo-deb packaging by pogmommy
Find a file
har7an beddfb77a8
Improve client disconnect handling (#2068)
* xtask/run: Use varargs when run with `-data-dir`

Previously any additional arguments passed on the command line were
ignored. Now they are appended to `cargo run ...` as documented.

* server/os_i_o: Improve error message when IPC dies

and display the last send/recv error to the user instead of a generic
"Buffer full" message.

* server/lib: Log error in `send_to_client!`

so we will know when an error occured while trying to send a message to
the client. The most likely cause for this is that the client buffer
filled up and hence we cannot send any new messages. While we still
disconnect the client as before, now we also write a log message that
explains the situation.

* utils/channel: Apply rustfmt

* server/lib: Detect when client responds too slow

and log a message before disconnecting it.

* server/os_i_o: Add retry queue to client senders

that is dynamically allocated on-demand and stores `ServerToClientMsg`
in case the regular IPC channel is currently full. This acts as a
dynamic buffer to hold and buffer messages for a while until the client
hopefully catches up.

Also write a message to the log to indicate when the client is
recognized to be too slow in handling server messages.

* server: apply rustfmt

* utils/ipc: Add session name to "Disconnect" error

* utils/ipc: Fix error message indent

* server/os_i_o: Undo IPC channel extension

via `Vec` and drastically increase the IPC message queue size instead.
Measurements didn't discover a drastic increase in RAM caused by this,
and it is a much easier fix for the problem at hand.

* CHANGELOG: Add PR #2068
2023-01-22 18:04:40 +00:00
.cargo WIP: Use xtask as build system (#2012) 2022-12-17 13:27:18 +00:00
.github chore(repo): remove nix support (#2038) 2022-12-20 12:24:19 +01:00
assets HOTFIX: utils: Move plugins into new assets folder (#2003) 2022-12-09 10:49:32 +00:00
default-plugins Floating panes in layouts (#2047) 2022-12-24 15:48:04 +01:00
docs docs: Improve error handling docs (#1919) 2022-11-09 18:01:36 +00:00
example add tmux close pane key (#2058) 2023-01-03 22:47:39 +09:00
src fix: wide-char drop on resize to 1 and invalid session names (#2082) 2023-01-13 18:23:21 +01:00
xtask Improve client disconnect handling (#2068) 2023-01-22 18:04:40 +00:00
zellij-client fix(panes): show visual error when failing to resize panes (#2036) 2022-12-19 12:48:43 +01:00
zellij-server Improve client disconnect handling (#2068) 2023-01-22 18:04:40 +00:00
zellij-tile chore: Bump development version 2022-12-13 17:24:19 +01:00
zellij-tile-utils chore: Bump development version 2022-12-13 17:24:19 +01:00
zellij-utils Improve client disconnect handling (#2068) 2023-01-22 18:04:40 +00:00
.editorconfig add: editorconfig (#1156) 2022-03-02 12:12:26 +01:00
.gitignore chore(repo): remove nix support (#2038) 2022-12-20 12:24:19 +01:00
.rustfmt.toml add(style): add trailing comma in match blocks (#1483) 2022-06-10 20:03:13 +02:00
Cargo.lock WIP: Use xtask as build system (#2012) 2022-12-17 13:27:18 +00:00
Cargo.toml WIP: Use xtask as build system (#2012) 2022-12-17 13:27:18 +00:00
CHANGELOG.md Improve client disconnect handling (#2068) 2023-01-22 18:04:40 +00:00
CODE_OF_CONDUCT.md docs(coc): initial 2020-10-27 11:11:10 +01:00
CONTRIBUTING.md chore(repo): remove nix support (#2038) 2022-12-20 12:24:19 +01:00
docker-compose.yml fix(docker-compose): Use the key-value style for environments to prevent human errors (#840) 2021-11-09 20:29:22 +01:00
GOVERNANCE.md docs(changelog): add emeritus 2022-12-20 10:04:34 +01:00
LICENSE.md Update references of mosaic to Zellij in md files 2021-02-10 12:12:19 +05:30
Makefile.toml Makefile: Fix CI ordering/dependencies (#2004) 2022-12-09 11:06:11 +00:00
README.md chore(repo): remove nix support (#2038) 2022-12-20 12:24:19 +01:00
rust-toolchain.toml [create-pull-request] automated change (#1980) 2022-12-01 09:40:36 +01:00


logo
Zellij

Discord Chat Matrix Chat Zellij documentation

demo

[Installation] [Overview] [Configuration] [Templates] [FAQ]

What is this?

Zellij is a workspace aimed at developers, ops-oriented people and anyone who loves the terminal. At its core, it is a terminal multiplexer (similar to tmux and GNU Screen), but this is merely its infrastructure layer.

Zellij includes a layout system, and a plugin system allowing one to create plugins in any language that compiles to WebAssembly.

You can get started by installing Zellij and reading the overview.

For more details about our future plans, read about upcoming features in our roadmap.

Zellij was initially called Mosaic.

How do I install it?

You can install with cargo:

cargo install --locked zellij

Or if want to a prebuilt binary, you can download it from our releases, or use cargo-binstall.

cargo-binstall zellij

Or you can also use Third Party Repositories.

Try Zellij without installing

bash/zsh:

bash <(curl -L zellij.dev/launch)

fish:

bash (curl -L zellij.dev/launch | psub)

How do I get involved?

Zellij is a labour of love built by an enthusiastic team of volunteers. We eagerly welcome anyone who would like to join us, regardless of experience level, so long as they adhere to our Code of Conduct.

Please report any code of conduct violations to aram@poor.dev

To get started, you can:

  1. Take a look at the Issues in this repository - especially those marked "good first issue". Those with the "help wanted" tag probably don't have anyone else working on them.
  2. Drop by our Discord, or Matrix chat and ask what you can work on, or how to get started.
  3. Open an issue with your idea(s) for the project or tell us about them in our chat.

How do I start a development environment?

  • Clone the project
  • In the project folder, for debug builds run: cargo xtask run
  • To run all tests: cargo xtask test

For more build commands, see CONTRIBUTING.md.

Configuration

For configuring Zellij, please see the Configuration Documentation.

What is the current status of the project?

Zellij should be ready for everyday use, but it's still classified as a beta. This means that there might be a rare crash or wrong behaviour here and there, but that once found it should be fixed rather quickly. If this happens to you, we would be very happy if you could open an issue and tell us how to reproduce it as best you can.

Roadmap

Presented here is the project roadmap, divided into three main sections.

These are issues that are either being actively worked on or are planned for the near future.

If you'll click on the image, you'll be led to an SVG version of it on the website where you can directly click on every issue

roadmap

License

MIT