JSPM

  • Created
  • Published
  • Downloads 51
  • Score
    100M100P100Q72294F
  • License MIT

Colson Tmux: Tmux + ZSH for Software Engineers!

Package Exports

  • colson-tmux
  • colson-tmux/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (colson-tmux) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Tmux Configuration with Zsh Goodness (colson-tmux npm)

Unlock the full potential of your terminal with this meticulously crafted tmux configuration, accompanied by a versatile Zsh script for effortlessly launching websites and applications. 🔥

Installation through NPM

Ensure Tmux is installed on your machine!
Tmux leader key: <ctrl>+<space>

$ npx colson-tmux
$ cd ~/.config/tmux
$ nvim .

Navigate to tmux.conf
Execute this command in normal mode!

<leader>+shit+i

Restart terminal to load Tmux!

$ zshrl
$ tmuxrl

If you've already installed this before then for the latest pull, do:

$ npx colson-tmux@latest

NOTE: Read the documentation below for indepth wisdom on proper installation and uses!

Table of Contents

Features

  1. Enhanced Tmux Configuration: Elevate your terminal experience with a comprehensive tmux setup tailored for efficiency.
  2. Web and App Launcher: Seamlessly launch websites and applications through an intuitive Zsh script.
  3. Plugin Management with TPM: Utilizes Tmux Plugin Manager (TPM) for hassle-free tmux plugin management.
  4. Catppuccin Theme: Elevate aesthetics with the visually pleasing Catppuccin theme.

Screenshots

✨ New Look (Colson TMUX)

colson tmux

colson tmux

colson tmux

colson tmux

colson tmux

colson tmux

colson tmux

colson tmux

💎 Old Look (Colson TMUX)

colson tmux

tmux colson

tmux colson

tmux colson

Prerequisites

Before diving in, ensure you have the following prerequisites:

  • tmux: Ensure tmux is installed on your system.
  • fzf: Install the fuzzy finder tool for interactive selection.

Getting Started

Installation

  1. Begin by installing TPM (Tmux Plugin Manager):

    git clone https://github.com/tmux-plugins/tpm ~/.tmux/plugins/tpm
  2. Clone this repository into your home directory:

    git clone https://github.com/colson0x1/colson-tmux ~/.config/tmux
  3. Reload your tmux environment to apply the configuration:

    tmux source-file ~/.config/tmux/tmux.conf
  4. Make the goto.sh script executable:

    chmod +x ~/.config/tmux/goto.sh
  5. Add .zshrc to root on your machine:

    cat ~/.config/tmux/.zshrc >> ~/.zshrc
  6. Restart your Terminal.

    $ source ~/.zshrc
    $ zshrl
    $ tmuxrl
  7. You're all set! Launch websites and applications using goto.sh.

    <leader>+o

    NOTE: Leader in tmux is: Ctrl+Space

Install Tmux Plugins

  1. Open tmux:
    tmux
  2. Navigate to the tmux directory:
    cd ~/.config/tmux
  3. Use Neovim to open the configuration:
    nvim .
  4. Go to tmux.conf:
    leader+shift+i
    (Note: Leader key is Ctrl+Space, so use Ctrl+Space and Shift+i)

Usage

  • Press ctrl+space to activate the leader key.
  • Switch between windows with M-K and M-J.
  • Split the terminal horizontally (leader + -) and vertically (leader + |).
  • Launch websites and apps with leader + o.
  • Customize website and app choices in goto.sh.

Key Bindings

Master these key bindings for efficient tmux navigation:

  • Leader Key: ctrl+space
  • Window Switching: Shift+Alt+j and Shift+Alt+k
  • Horizontal Split: leader + -
  • Vertical Split: leader + |
  • Launch Websites and Apps: leader + o

Customization

Tailor your tmux configuration and the list of websites and applications in goto.sh to match your preferences. Dive into the endless possibilities of customization and make your terminal truly yours. Additionally, explore the power of Zsh with a rich set of aliases and Git shortcuts in the included .zshrc file.

Peace!