콘텐츠로 이동

Install xds

이 콘텐츠는 아직 번역되지 않았습니다.

xds scaffolds a new project from this template. You choose a project name, the client stacks to include, and a color theme, and xds generates a repository containing only those stacks with the acme placeholder replaced by your project name.

The template files are compiled directly into the binary. xds requires no network access, and a given version always scaffolds the exact template snapshot from when that binary was built.

Terminal window
npm install --global xds-cli
xds --version

Or run it directly without installing globally:

Terminal window
npx xds-cli create my-app
npm create xds@latest my-app

xds-cli is a small launcher script. The native binary comes from an optional platform-specific package that npm selects by os and cpu: xds-cli-darwin-arm64, xds-cli-darwin-x64, xds-cli-linux-arm64, xds-cli-linux-x64, or xds-cli-win32-x64. If you install with --omit=optional, npm skips the platform package and the launcher exits with an error message explaining why.

Terminal window
curl -fsSL https://raw.githubusercontent.com/kjmin-dev/xds/main/install.sh | sh

The script downloads the prebuilt binary for your machine from the latest GitHub release, verifies its SHA-256 checksum, and installs it to ~/.local/bin. If that directory is not on your PATH, the script prints the line to add to your shell profile.

Variable Meaning Default
XDS_VERSION Specific release version to install, such as 0.1.0 Latest release
XDS_INSTALL_DIR Directory where the binary is installed $HOME/.local/bin
XDS_DOWNLOAD_BASE Custom URL or local directory containing the release archives, overriding GitHub Releases
Terminal window
curl -fsSL https://raw.githubusercontent.com/kjmin-dev/xds/main/install.sh | XDS_VERSION=0.1.0 XDS_INSTALL_DIR=/usr/local/bin sh

Prebuilt binaries are available for macOS (arm64, x86_64) and Linux (arm64, x86_64; statically linked so they run on any distribution). On Windows, install via npm.

From a local checkout of this repository with the toolchain installed via mise install:

Terminal window
cargo install --path cli # installs xds into ~/.cargo/bin
mise run xds -- list # or run it without installing
mise run build:cli # the release build, at target/dist/xds