Skip to content

cor/open-project

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

open-project

open-project is a command-line utility written in Rust to streamline management of local clones of GitHub repos and opening them in your preferred terminal multiplexer (tmux or Zellij).

Just type open-project user repo to automatically clone the repo if necessary and open it in tmux (default) or Zellij.

Install

Make sure you have either tmux or Zellij installed:

Build open-project with either nix or cargo and add the binary to your $PATH.

Nix

nix build github:cor/open-project

Cargo

git clone https://github.com/cor/open-project
cd open-project
cargo build --release

Usage

open-project [OPTIONS] <username> <projectname>

Options

  • -m, --multiplexer <MULTIPLEXER>: Choose terminal multiplexer (tmux or zellij) [default: tmux]

Environment Variables

  • TERMINAL_MULTIPLEXER: Set default multiplexer (overrides CLI default, but CLI flag takes precedence)

Examples

# Use default (tmux)
open-project alice my-repo

# Use zellij
open-project -m zellij alice my-repo

# Use environment variable
TERMINAL_MULTIPLEXER=zellij open-project alice my-repo

This will:

  1. Check for a directory $HOME/dev/alice and prompt to create it if missing.
  2. Check for the repository my-repo under the user's GitHub and clone it if not present.
  3. Attach to or create a session in your chosen multiplexer.

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to improve this tool.

About

open github repo in zellij

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors