zellij-org/zellij
1
1
Fork 0
mirror of https://github.com/zellij-org/zellij.git synced 2024-12-29 20:21:39 +03:00
Code Issues Projects Releases Wiki Activity
A terminal workspace with batteries included
586 Commits 286 Branches 65 Tags 151 MiB
Rust 99.9%
f172a01dac
Go to file
a-kenji f172a01dac
Merge pull request #391 from a-kenji/config-loading 
Load Config from Assets
2021-04-27 22:58:19 +02:00
.github feat(ci): add M1 macOS builds 2021-04-27 18:52:05 +01:00
assets Config Loading 2021-04-27 21:38:26 +02:00
default-plugins fix(naming): made plugin terminology more consistent 2021-04-19 23:37:47 +01:00
docs Update references of mosaic to Zellij in md files 2021-02-10 12:12:19 +05:30
example Requested Changes to 362: 2021-04-25 11:52:31 -07:00
src Merge branch 'main' of https://github.com/zellij-org/zellij into config-loading 2021-04-27 21:40:13 +02:00
zellij-tile feat(plugin): simple timers implemented via the set_timeout() call 2021-04-27 17:13:25 +01:00
.gitignore feature(release): added automatic release on pushing tag v*.*.* 2021-04-24 13:47:14 +03:00
Cargo.lock feat(plugin): added the get_plugin_ids() query function 2021-04-27 14:57:54 +01:00
Cargo.toml feat(plugin): added the get_plugin_ids() query function 2021-04-27 14:57:54 +01:00
CHANGELOG.md Merge branch 'main' of https://github.com/zellij-org/zellij into config-loading 2021-04-27 21:40:13 +02:00
CODE_OF_CONDUCT.md docs(coc): initial 2020-10-27 11:11:10 +01:00
CONTRIBUTING.md docs(build): update CONTRIBUTING.md 2021-04-14 19:11:24 +01:00
GOVERNANCE.md Add Kyle to governance.md 2021-04-03 01:42:13 -07:00
LICENSE.md Update references of mosaic to Zellij in md files 2021-02-10 12:12:19 +05:30
Makefile.toml fix(ci): fix cross compiliation 2021-04-26 23:33:53 +01:00
README.md docs(readme): add link 2021-04-19 23:02:45 +02:00
rust-toolchain feat(ci): add CI trigger for manual builds 2021-04-26 18:58:42 +01:00

README.md


logo
Zellij

demo

Discord Chat

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.

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 it through cargo:

cargo install zellij

Or you can download a prebuilt binary from our Releases.

How do I hack on it?

  • Clone the project
  • Install cargo-make with cargo install --force cargo-make
  • In the project folder, run: cargo make run

For more build commands, take a look at 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.

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.

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 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.

And most importantly, please read our code of conduct.

Roadmap

This section contains an ever-changing list of the major features that are either currently being worked on, or planned for the near future.

  • A web client/server - Connect to Zellij through the browser instead of opening a terminal window. Either on a local or remote machine.
  • Share sessions with others - See the focused window and cursor of other users, work on a problem or a code base together in real time.
  • Support for multiple terminal windows across screens - Transfer panes across different windows and screens by having them all belong to the same session.
  • Smart layouts - expand the current layout system so that it rearranges and hides panes intelligently when new ones are added or the window size is changed.

Contributing

Take a look at Contributing.md guide.

License

MIT