Installation Guide

This guide outlines how to install, update, and uninstall x-cmd on various shell environments and operating systems.

x-cmd is a command-line library/toolbox developed using Posix Shell compatible syntax, prioritizing flexibility and lightweight design. To minimize system impact, x-cmd core operations only rely on pre-installed system commands and operate solely within the user directory. Therefore, installation and most usage scenarios do not require root privileges.

Differences exist between different systems and shells. Thanks to user feedback and support, x-cmd has provided corresponding solutions for these differences. This document summarizes these solutions and provides links to relevant documentation.

After successful installation, welcome to read our Getting Started Guide ~ This guide will help you quickly master the core functions of x-cmd, including auto-completion, theme customization, module management, and package management, to help you get started quickly.

Installation using Posix Shell Script

The most convenient installation method is to use the installation script provided by x-cmd, which is hosted at https://get.x-cmd.com.

This script is written using Posix Shell compatible syntax. Users can download it using curl or wget and run it directly in bash, zsh, dash, ash.

eval "$(curl https://get.x-cmd.com)"

Or

eval "$(wget -O- https://get.x-cmd.com)"

curl - curl command installation

Installing x-cmd in Fish, Elvish, Nushell, xonsh, tcsh

Because the installation script is written using POSIX shell syntax, it cannot be run directly in non-POSIX shell environments (such as fish, elvish, nushell, xonsh, tcsh). Therefore, please use the following command:

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

Or

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

After installation, to automatically load x-cmd when the shell starts, we provide a quick configuration command like x <shell-name> --setup.

For example, with fish:

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

We have prepared special documentation for users of the following shells to further improve the onboarding experience:

• fish
• elvish
• nushell
• xonsh
• tcsh

Installing x-cmd on Windows and Powershell

We provide a x-cmd.bat batch script for download. Users only need to double-click to open it to trigger the installation.

At the same time, x-cmd also provides an installation script written in Powershell. Users can call the following command in powershell to download the script and trigger the installation.

[System.Text.Encoding]::GetEncoding("utf-8").GetString($(Invoke-WebRequest -Uri "https://get.x-cmd.com/x-cmd.ps1").RawContentStream.ToArray()) | Invoke-Expression

Please go to Windows Installation, this document provides a detailed introduction, precautions, and principle explanation for Windows systems.

Powershell users can also directly access the Powershell dedicated document

Install via System Package Managers

homebrew

brew install x-cmd

Once the installation is successful, you'll need to activate it within your current user environment.

x-cmd

apt

Currently awaiting community review.

apk

Currently awaiting community review.

pacman

Currently awaiting community review.

dnf

Currently awaiting community review.

Other Installation Methods: Docker Container, SSH Remote Installation

Package Manager (Planned)

We have submitted x-cmd to system package managers like brew, apt, apk; it is estimated to be available soon.

Docker Container

In a minimalist Linux container environment without pre-installed curl or wget, you can use the following command to quickly install x-cmd:

x docker run -x -it <container name or id>

x docker setup <container name or id>

• For the x docker command, please refer to the x-cmd Docker module documentation.

Installing x-cmd on a remote host via SSH

The basic principle is to use scp to transfer the x-cmd all-in-one installation package to the user directory of the remote server and trigger decompression and automatic configuration.

Updating x-cmd: x upgrade

Updating x-cmd is very simple; just run the x upgrade command.

Or run the installation script again:

eval "$(curl https://get.x-cmd.com)"

Note:

• The upgrade process will not delete older versions of x-cmd, nor will it affect other open shell environments.
• For a more detailed explanation and principle analysis, please refer to the relevant documentation.

Uninstalling x-cmd

Uninstalling x-cmd is very simple; just run the following command:

x uninstall

This will delete the ~/.x-cmd.root directory and clear the x-cmd loading command from the shell configuration file (such as ~/.bashrc).

Note:

• Before uninstalling, ensure that no active processes are calling x-cmd.
• For a more detailed explanation and principle analysis, please refer to the relevant documentation.