zellij README

The project's README from github.com/zellij-org/zellij. As one markdown file: README.md.


logo
Zellij

demo

[Installation] [Screencasts & Tutorials] [Configuration] [Layouts] [FAQ]

Discord Chat Matrix Chat Zellij documentation


Sponsored by     gresearch logo

What is this?

Zellij is a workspace aimed at developers, ops-oriented people and anyone who loves the terminal. Similar programs are sometimes called "Terminal Multiplexers".

Zellij is designed around the philosophy that one must not sacrifice simplicity for power, taking pride in its great experience out of the box as well as the advanced features it places at its users' fingertips.

Zellij is geared toward beginner and power users alike - allowing deep customizability, personal automation through layouts, true multiplayer collaboration, unique UX features such as floating and stacked panes, and a plugin system allowing one to create plugins in any language that compiles to WebAssembly.

Zellij includes a built-in web-client, making a terminal optional.

You can get started by installing Zellij and checking out the Screencasts & Tutorials.

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

How do I install it?

The easiest way to install Zellij is through a package for your OS.

If one is not available for your OS, you could download a prebuilt binary from the latest release and place it in your $PATH. If you'd like, we could automatically choose one for you.

You can also install (compile) with cargo:

cargo install --locked zellij

Try Zellij without installing

bash/zsh:

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

fish/xonsh:

bash -c 'bash <(curl -L https://zellij.dev/launch)'

Installing from main

Installing Zellij from the main branch is not recommended. This branch represents pre-release code, is constantly being worked on and may contain broken or unusable features. In addition, using it may corrupt the cache for future versions, forcing users to clear it before they can use the officially released version.

That being said - no-one will stop you from using it (and bug reports involving new features are greatly appreciated), but please consider using the latest release instead as detailed at the top of this section.

How do I start a development environment?

For more build commands, see CONTRIBUTING.md.

Configuration

For configuring Zellij, please see the Configuration Documentation.

About issues in this repository

Issues in this repository, whether open or closed, do not necessarily indicate a problem or a bug in the software. They only indicate that the reporter wanted to communicate their experiences or thoughts to the maintainers. The Zellij maintainers do their best to go over and reply to all issue reports, but unfortunately cannot promise these will always be dealt with or even read. Your understanding is appreciated.

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

Origin of the Name

From Wikipedia, the free encyclopedia

Zellij (Arabic: الزليج, romanized: zillīj; also spelled zillij or zellige) is a style of mosaic tilework made from individually hand-chiseled tile pieces. The pieces were typically of different colours and fitted together to form various patterns on the basis of tessellations, most notably elaborate Islamic geometric motifs such as radiating star patterns composed of various polygons. This form of Islamic art is one of the main characteristics of architecture in the western Islamic world. It is found in the architecture of Morocco, the architecture of Algeria, early Islamic sites in Tunisia, and in the historic monuments of al-Andalus (in the Iberian Peninsula).

License

MIT

Sponsored by

zellij (zellij-org/zellij)

Searching Database…

35.7K ·GitHub
这是什么?Zellij 是一个终端工作区(常被称为终端复用器),可以把终端分割成窗格和标签页,支持布局和插件,开箱即用、易于上手,同时功能也很强大。
这是一个库,还是可以直接在终端里运行的程序?它是一个独立的终端应用(TUI),可以直接在终端中运行,而不是需要导入代码中的库。
我该如何安装并开始使用?可以通过操作系统的包管理器安装,也可以从最新发布版本下载预编译的可执行文件并放入 $PATH,或者使用 cargo 从源码编译。
运行它需要安装 Rust 或 cargo 吗?不需要,只有在想从源码构建时才需要 cargo;否则可以直接使用预编译的可执行文件或操作系统的安装包。
我应该使用主分支的版本吗?不建议。主分支是尚未发布的代码,可能无法正常运行甚至不可用,还可能损坏缓存,影响之后的正式版本,因此建议使用最新发布的版本。
这个工具面向哪些人?它既适合终端新手,也适合高级用户,包括开发者和运维人员,并为高级用户提供了深度的自定义能力。
它能在 Linux 和 macOS 上运行吗?可以,平台标签和打包信息都确认支持 Linux 和 macOS;此外,它还可以通过内置的 Web 客户端在浏览器中运行。
多个人可以同时共享同一个终端会话吗?可以,Zellij 支持真正的多人协作,多个用户可以在同一个终端会话中一起工作。
我可以用任何编程语言为 Zellij 编写插件吗?可以,Zellij 的插件系统支持任何能编译为 WebAssembly 的语言。
我可以不先安装就试用 Zellij 吗?可以,README 中提供了无需安装即可试用的方法,并分别给出了 bash/zsh 和 fish/xonsh 两种 shell 的说明。
Zellij 这个名字是从哪里来的?Zellij 的名字来源于一种传统的伊斯兰马赛克瓷砖装饰风格,由手工凿制的瓷片拼成几何图案,常见于摩洛哥、阿尔及利亚、突尼斯和安达卢西亚的建筑之中。
What are similar projects?herdr, yazi, cocode, coreutils, soundcraft, tuios, wezterm, neovim
Creator
zellij-org
Size
266.6 MB
Stars
35.7K
Age
6y
Commits · 90 Days