Skip to content

Latest commit

 

History

History
96 lines (66 loc) · 2.85 KB

install.md

File metadata and controls

96 lines (66 loc) · 2.85 KB
Raw

Installation

You can install xshe with Cargo (Rust's package manager) or with Homebrew (a package manager for macOS and Linux), provided you have one of them installed on your system.

If you don't have Cargo or Homebrew, or if you don't want to use either of them, you can also download the binaries for your system directly from GitHub, or build xshe directly.

?> Note: After installing xshe with Cargo or from a download, you might have to add the resulting xshe binary to your PATH. (what's that?)

With Cargo

If you have Cargo installed, use this command to install xshe from crates.io with Cargo:

cargo install -f xshe

With Homebrew

If you have Homebrew installed, we recommend that you install xshe with Homebrew instead of Cargo.

Simply run:

brew install superatomic/tap/xshe

Installing xshe with Homebrew adds autocompletion to any shells that have completion enabled.

With Eget

If you have Eget installed, just run:

eget superatomic/xshe

This will install a prebuilt binary of xshe.

As a file download

?> This method will not add xshe to your PATH. Make sure to add the xshe binary to your PATH manually, or remember to use the full path to the binary whenever you run xshe.

Instead of using Cargo, you can download the latest release binary that corresponds with your system (or view all releases).

Make sure to add the binary to your PATH.

Build from source

First, download the repo:

!> This installs the latest development version of xshe, which may be ahead of the current stable release. If you want the latest stable version instead, build from the latest git tag or download the source for the latest version from the releases page.

To build xshe from source:

git clone https://github.com/superatomic/xshe
cd xshe
cargo build --release
sudo mv target/release/xshe /usr/local/bin  # <-- optional

Make sure to place the generated binary at target/release/xshe on your PATH. In this example, xshe is installed to /usr/local/bin, but xshe can anywhere on your PATH.

Next steps

  1. Create an xshe.toml file to define your environment variables for every shell →
  2. Add xshe to the startup script of every shell →