https://github.com/gitpod-samples/gitpod.zellij

Zellij plugin for Gitpod, with .gitpod.yml tasks integration.
https://github.com/gitpod-samples/gitpod.zellij

dotsh gitpod gitpod-dotfiles zellij zellij-plugin

Last synced: about 2 months ago
JSON representation

Zellij plugin for Gitpod, with .gitpod.yml tasks integration.

• Host: GitHub
• URL: https://github.com/gitpod-samples/gitpod.zellij
• Owner: gitpod-samples
• Created: 2023-07-01T19:08:29.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-13T10:08:41.000Z (4 months ago)
• Last Synced: 2024-09-13T23:51:35.808Z (4 months ago)
• Topics: dotsh, gitpod, gitpod-dotfiles, zellij, zellij-plugin
• Language: Rust
• Homepage:
• Size: 8.79 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
https://github.com/axonasif/gitpod.zellij/assets/39482679/89d3ad1c-7c36-43d9-924b-29a65bcf591a

Zellij plugin for Gitpod, with `.gitpod.yml` tasks integration. 

# Installation

## Quickstart

If you want to try it out as is:

- Go to  and scroll down.

- Set  as **Dotfiles - Repository URL** and click on `Save`.

## Custom setup

If you already have a dotfiles repository that you use on Gitpod, you can copy the contents from [install.sh](./install.sh) and append (while excluding the first shebang line) to your own [installation script](https://www.gitpod.io/docs/configure/user-settings/dotfiles#custom-installation-script).

# Customization

## Default editor

This plugin will spawn an editor in the first tab. It's not necessary for you to specify one, the plugin uses some heuristics to auto detect the available editor. But in case you want to override it, you can do so by creating a variable named `EDITOR` on  with a value (e.g. `nvim`) and `*/*` as scope.

# Roadmap

This plugin is minimal in its current form. The goal is to have similar features as [gitpod.tmux](https://github.com/axonasif/gitpod.tmux). If you are interested in any of the below features in particular, please [raise an issue](https://github.com/axonasif/gitpod.zellij/issues/new/choose) to let me know.

- [x] `.gitpod.yml` tasks integration

- [ ] Resource meters: CPU, DISK and MEMORY

- [ ] Custom keybindings

- [ ] Newly opened port notification

- [ ] Functions menu

  - [ ] Manage ports

  - [ ] Stop workspace

- [ ] Custom Gitpod theme

- [ ] Indicator for dotfiles installation progress

- [ ] Watch `.gitpod.yml` changes for prompting to run `gp validate`

# Development and contributing

[![Hack in Gitpod!](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#github.com/axonasif/gitpod.zellij)

As in [.gitpod.yml](./.gitpod.yml), you will need to run the plugin in the background first and then start zellij: `cargo run & zellij`