fish

Overview ​

fish (Friendly Interactive Shell) is a user-friendly, intelligent command line shell. The x-cmd toolkit integrates with fish to add more enjoyment and efficiency to your command line journey.

Installing x-cmd ​

1. One-Line Installation

   Install using curl or wget:

   bash

   curl https://get.x-cmd.com | sh

   or

   bash

   wget -O- https://get.x-cmd.com | sh

2. Auto-Load at Startup

   Configure fish to automatically load x-cmd at startup:

   bash

   ~/.x-cmd.root/bin/x-cmd fish --setup

   If x command is already available in the current shell (such as bash), you can use:

   bash

   x fish --setup

Theme Customization ​

While x-cmd's theme module only supports POSIX shells, you can use ohmyposh and starship themes through x-cmd:

x starship

x ohmyposh

x-cmd provides dedicated starship and ohmyposh modules with automatic installation, configuration, and theme preview features.

Smart Completions ​

After starting x-cmd, fish's command completion features are automatically activated.

How x fish --setup Works ​

fish loads the $HOME/.config/fish/config.fish file by default. x fish --setup adds this at the beginning:

test ! -e "$HOME/.x-cmd.root/local/data/fish/rc.fish" || source "$HOME/.x-cmd.root/local/data/fish/rc.fish"  # boot up x-cmd.

It also initializes the $HOME/.x-cmd.root/local/data/fish/rc.fish file. The source code is available in the x-cmd repository.

x fish: Running Fish Scripts ​

Even without fish pre-installed, you can use x fish to download and run fish scripts:

x fish                  # Interactive fish shell

x hi.fish               # Run hi.fish in current directory
x fish hi.fish          # Equivalent command

x ljh:hi.fish           # Run script shared by author ljh on x-cmd hub
x fish ljh:hi.fish      # Equivalent command

For more information about the x-cmd hub service, see the hub module documentation.

Using x-cmd in Fish Scripts ​

x-cmd Already Installed ​

If x-cmd is already installed in the environment, use x fish to run scripts:

# v0.5.10 and above supported
source $HOME/.x-cmd.root/boot/rc.fish

# Now you can use x commands in the script

Notes:

• Unlike other shells, fish loads config.fish by default when executing scripts (non-interactive mode)
• Use --no-config or -N flag to prevent loading

Installing x-cmd On-Demand ​

Install x-cmd on-demand in fish scripts (ensure curl or wget is installed):

test -f "$HOME/.x-cmd.root/X" || ! command -v curl || curl https://get.x-cmd.com | sh
test -f "$HOME/.x-cmd.root/X" || ! command -v wget || wget -O- https://get.x-cmd.com | sh

# v0.5.10 and above supported
source $HOME/.x-cmd.root/boot/rc.fish
# Now you can use x commands in the script

If you have any questions, feel free to provide feedback at the x-cmd source repository.