Skip to main content

⚓ Installation

·190 words

🍺 Homebrew
#

Install sibling via Homebrew, simply run:

brew install tamada/tap/sibling

And put the snippet of your shell into your shell profile. The --init option accepts bash, zsh, fish, powershell, and elvish; other shells are not supported, yet.

ShellProfileSnippet
bash.bash_profileeval "$(sibling --init bash)"
zsh.zshrceval "$(sibling --init zsh)"
fishconfig.fishsibling --init fish | source
PowerShell$PROFILEsibling --init powershell | Out-String | Invoke-Expression
Elvishrc.elvuse sibling (see the note below)

Elvish loads the functions as a module, not by evaluating them. Save the script into the lib directory, which is usually ~/.config/elvish/lib, and use it in your rc.elv; the commands are namespaced, such as sibling:cdnext.

$ sibling --init elvish > ~/.config/elvish/lib/sibling.elv
use sibling
# to call them by the bare names
var cdnext~ = $sibling:cdnext~
var cdprev~ = $sibling:cdprev~

💪 Compiling yourself
#

Get source codes by git clone or download from GitHub, then run cargo to build sibling

$ git clone https://github.com/tamada/sibling.git # or download from https://github.com/tamada/sibling
$ cd sibling
$ cargo build

💼 Requirements
#

Development
#

  • Rust 1.78 or later
  • Dependencies (See Cargo.toml)
    • clap 4.5.23
    • rand 0.8.5
    • rust-embed 8.5.0