xshe allows for setting Shell Environment Variables across multiple shells with a single TOML configuration file.

Simply write lines in a xshe.toml file like this:

toml CARGO_HOME = "~/.cargo"

Create a file like this once and use it everywhere, for every shell! xshe can convert this format into the format for every supported shell.

Installation

You can install xshe from [Cargo] (Rust's package manager) if you have it installed on your system. If you don't have Cargo or don't want to use it, you can also download the binaries for your system directly from GitHub, or [install Cargo/Rust] first before proceeding.

Note: After installing xshe, you might have to add the resulting xshe binary to your PATH. ^{(what's that?)}

With Cargo

Install xshe from crates.io with [Cargo].

shell cargo install -f xshe

As a File Download

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 xshe binary to your PATH, or remember to use the full path to the binary whenever you run xshe.

Setup

Creating a xshe.toml file

Create a file called xshe.toml in ~/.config. This is a TOML file that represents environment variables.

One variable is set per line. The file is read in order from top to bottom, so variables that appear earlier in the file can be used to define ones that appear later.

A typical line looks like this:

toml CARGO_HOME = "$XDG_DATA_HOME/cargo"

This will then be converted into the correct format for whatever shell is being used. For example, in bash, this line becomes:

bash export CARGO_HOME="$XDG_DATA_HOME/cargo"; While in fish, this line is: fish set -gx CARGO_HOME "$XDG_DATA_HOME/cargo";

Dealing with PATH variables

To set variables that are arrays of values, like $PATH, use this syntax:

toml PATH = ["$PATH", "$BIN_HOME", "$CARGO_HOME/bin"] xshe will join each element together based on the shell that is specified.

Shell Specific Environment Variables

To set environment variables for only one shell, add a .NAME prefix after the name of the environment variable, where NAME is one of bash, zsh, or fish. These environment variables will only be added if the given shell is used.

As an example, these lines make $HISTFILE be set to different values between different shells, and to have $ZSH_CACHE_DIR only be set in zsh, do this:

```toml HISTFILE.bash = "$XDGSTATEHOME/bashhistory" HISTFILE.zsh = "$XDGSTATEHOME/zshhistory"

ZSHCACHEDIR.zsh = "$XDGCACHEHOME/oh-my-zsh" ```

You can use ._ instead of using a shell name to specify a default if an option doesn't apply to any of the shells. For example, these lines set the $EDITOR to nano on bash, but micro on everything else:

toml EDITOR.bash = "$(which nano)" EDITOR._ = "$(which micro)"

Sourcing the xshe.toml file

Put the line corresponding to your shell in whatever file runs when loading environment variables. For bash, this is ~/.bash_profile, for zsh, this is ~/.zshenv, and for fish, this is ~/.config/fish/config.fish.

Bash

bash eval "$(xshe bash)"

Zsh

zsh eval "$(xshe zsh)"

Fish

fish xshe fish | source

Use without xshe on PATH

If xshe isn't on your PATH (this is the cause of the error command not found: xshe), you will have to manually type out the location:

zsh eval "$(/path/to/xshe zsh)"

Options

Using --file (or -f)

To specify a custom file that is not located at ~/.config/xshe.toml, pass the --file option, like so:

zsh eval "$(xshe zsh --file ~/some/other/location.toml)"

Using --toml (or -t)

To directly specify TOML to parse as a config file, use --toml.

For example, this line directly parses the provided line and converts it to zsh: zsh xshe zsh --toml 'BIN_HOME = "$HOME/.local/bin"'

Using --pipe (or -p)

To pass a TOML configuration from the standard input, use --pipe.

As an example, this command concatenates two files named global_xshe.toml and user_xshe.toml by using cat, and then pipes the output into xshe to be parsed: zsh cat global_xshe.toml user_xshe.toml | xshe zsh --pipe

Other CLI Options

Output Verbosity

You can control how much info is displayed when Xshe is run. The default behavior is to only display errors and warnings.

While this default behavior is recommended, you can customize it by using the following flags:

• -qq silences all output (this silences errors and is not advised)
• -q or --quiet shows only errors and hides warnings
• -v or --verbose shows info messages
• -vv shows debug logs
• -vvv shows trace logs

Help and Version Information

Run xshe --help to display command usage.

Run xshe --version to display version information.

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.