Skip to content

Latest commit

 

History

History
151 lines (88 loc) · 4.86 KB

README.md

File metadata and controls

151 lines (88 loc) · 4.86 KB
Raw

Latest Release Lint CI Test pre-commit Conventional Commits KeepAChangelog

zsh-tmux

zsh-tmux plugin for zsh.

Requirements

This is a list of plugins that need to be installed previously to enjoy all the goodies of this configuration:

Installation

oh-my-zsh users

If you're using oh-my-zsh, install this plugin by doing the following:

  1. Go to your oh-my-zsh custom plugins directory -cd ~/.oh-my-zsh/custom/plugins
  2. Clone the plugin bash git clone https://github.com/hadenlabs/zsh-tmuxbash
  3. Edit your .zshrc and add plugins=( ... zsh-tmux ) to your list of plugins
  4. Open a new terminal and enjoy!

antigen users

If you're using Antigen, install this plugin by doing the following:

  1. Add antigen bundle hadenlabs/zsh-tmux to your .zshrc where you're adding your other plugins.
  2. Either open a new terminal to force zsh to load the new plugin, or run antigen bundle hadenlabs/zsh-tmux in a running zsh session.
  3. Enjoy!

antibody users

If you're using Antibody, install this plugin by doing the following:

  1. Add :
antibody bundle hadenlabs/zsh-tmux

to your .zshrc where you're adding your other plugins.

  1. Either open a new terminal to force zsh to load the new plugin, or run antibody bundle hadenlabs/zsh-tmux in a running zsh session.
  2. Enjoy!

Usage

How to use this project

Replace name project to New Project

agr 'zsh-tmux' 'new-project'

Examples

Common

Functions

zsh tmux includes a small utility tmux.

tmux::post_install

Synchronizes and install configurations.

tmux::sync

Synchronizes the configurations that are in conf/.tmux.conf

tmux::install

Install tmux

tx::project name_project

Run tmux session using tmuxinator template project

ftm

Create new tmux session, or switch to existing one.

ftmk

Delete tmux session.

Help

Got a question?

File a GitHub issue.

Contributing

See Contributing.

Module Versioning

This Module follows the principles of Semantic Versioning (SemVer).

Using the given version number of MAJOR.MINOR.PATCH, we apply the following constructs:

  1. Use the MAJOR version for incompatible changes.
  2. Use the MINOR version when adding functionality in a backwards compatible manner.
  3. Use the PATCH version when introducing backwards compatible bug fixes.

Backwards compatibility in 0.0.z and 0.y.z version

  • In the context of initial development, backwards compatibility in versions 0.0.z is not guaranteed when z is increased. (Initial development)
  • In the context of pre-release, backwards compatibility in versions 0.y.z is not guaranteed when y is increased. (Pre-release)

Copyright

Copyright © 2018-2023 Hadenlabs

Trademarks

All other trademarks referenced herein are the property of their respective owners.

License

The code and styles are licensed under the LGPL-3.0 license See project license..

Don't forget to 🌟 Star 🌟 the repo if you like zsh-tmux

Your feedback is appreciated