99e2bef8c6
* utils: re-export "anyhow" unconditionally even for wasm targets. * utils/errors: Share wasm-compatible code and move everything that can't run in wasm into a separate submodule. * utils: Share "errors" module unconditionally The module is now structured such that all code incompatible with wasm targets lives in its own submodule that isn't included when compiling for wasm targets. * utils/errors: Add "Help wanted" doc section that informs the reader about the endeavour to improve error handling throughout the zellij code base. * plugins: Handle errors returned by `zellij_tile` now that the panic calls have been removed. * utils/errors: Extend `anyhow::Result` with traits that allow for easy/concise logging of `anyhow::Result` types and panicking the application when they are fatal or non-fatal. * utils/errors: Fix doctest * utils/errors: Add prelude that applications can import to conveniently access the error handling functionality part of the module. Re-exports some parts and macros from anyhow and the `LoggableError` and `FatalError` traits. * server/screen: Adopt error handling and make all fallible functions from the public API return a `Result`. Append error contexts in all functions that can come across error types to allow tracing where an error originates and what lead there. * server/lib: Catch errors from `screen` and make them `fatal`. This will log the errors first, before unwrapping on the error type and panicking the application. * server/unit/screen: Fix unit tests and unwrap on the `Result` types introduced from the new error handling. * utils/errors: Track error source in calls to `fatal`, so we keep track of the location where the panic really originates. Otherwise, any call to `fatal` will show the code in `errors` as source, which of course isn't true. Also change the error formatting and do not call `to_log` for fatal errors anymore, because the panic is already logged and contains much more information. * utils/errors: Update `FatalError` docs * plugins: Undo accidental modifications * utils/errors: Improve module docs explain some error handling facilities and the motivation behind using them. * server/screen: Remove `Result` from Infallible functions that are part of the public API. |
||
|---|---|---|
| .cargo | ||
| .github | ||
| .nix | ||
| assets | ||
| default-plugins | ||
| docs | ||
| example | ||
| src | ||
| zellij-client | ||
| zellij-server | ||
| zellij-tile | ||
| zellij-tile-utils | ||
| zellij-utils | ||
| .editorconfig | ||
| .envrc | ||
| .git-blame-ignore-revs | ||
| .gitignore | ||
| .rustfmt.toml | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| docker-compose.yml | ||
| flake.lock | ||
| flake.nix | ||
| GOVERNANCE.md | ||
| LICENSE.md | ||
| Makefile.toml | ||
| README.md | ||
| rust-toolchain.toml | ||
| treefmt.toml | ||
Zellij
[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 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:
- 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.
- Drop by our discord, or matrix chat and ask what you can work on, or how to get started.
- 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
- Install cargo-make with
cargo install --locked --force cargo-make - In the project folder, for debug builds run:
cargo make run - To run all tests:
cargo make 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
License
MIT