Installation

The xyz CLI provides a Solana-like interface for interacting with XYZ Chain. This guide covers installation methods for different platforms.

Prerequisites

Go 1.21+ - Download
Git - For cloning the repository
Make - For building from source

Install from Source

Clone and Build

# Clone the repository
git clone https://github.com/xyzchainorg/xyz
cd xyz

# Install the xyz CLI
make install-cli

# Verify installation
xyz --version

Install Both CLIs

To install both xyz (developer CLI) and xyzd (chain daemon):

make install

Binary Locations

After installation, binaries are located at:

Binary	Location
`xyz`	`$GOPATH/bin/xyz`
`xyzd`	`$GOPATH/bin/xyzd`

Ensure $GOPATH/bin is in your PATH:

export PATH=$PATH:$(go env GOPATH)/bin

Add this to your shell profile (~/.bashrc, ~/.zshrc, etc.) for persistence.

Verify Installation

# Check version
xyz --version

# View help
xyz --help

Expected Output

xyz - Solana-like CLI for XYZ Chain

Usage:
  xyz [command]

Available Commands:
  balance     Query account balance
  chain       Chain information commands
  completion  Generate shell completion script
  config      Configuration management
  help        Help about any command
  init        Scaffold a new CosmWasm contract project
  keys        Key management commands
  localnet    Local development network commands
  program     Smart contract commands
  token       CW20 token commands
  tx          Transaction commands

Flags:
      --chain-id string           Chain ID (default "xyz-testnet-1")
  -h, --help                      help for xyz
      --home string               Home directory (default "~/.xyz")
      --keyring-backend string    Keyring backend (os|file|test) (default "os")
      --node string               Node RPC endpoint (default "tcp://localhost:26657")

Use "xyz [command] --help" for more information about a command.

Shell Completion

Enable tab completion for faster command entry:

Bash
Zsh
Fish
PowerShell

# Add to ~/.bashrc
source <(xyz completion bash)

# Or install system-wide
xyz completion bash > /etc/bash_completion.d/xyz

# Add to ~/.zshrc
source <(xyz completion zsh)

# Or install to fpath
xyz completion zsh > "${fpath[1]}/_xyz"

xyz completion fish | source

# Or install permanently
xyz completion fish > ~/.config/fish/completions/xyz.fish

xyz completion powershell | Out-String | Invoke-Expression

Configuration

Initial Setup

# Set default node
xyz config set node tcp://localhost:26657

# Set chain ID
xyz config set chain-id xyz-testnet-1

# Set keyring backend
xyz config set keyring-backend os

View Configuration

xyz config list

Output:

node: tcp://localhost:26657
chain-id: xyz-testnet-1
keyring-backend: os
home: /Users/you/.xyz

Directory Structure

The CLI stores data in ~/.xyz/:

~/.xyz/
├── config.yaml        # CLI configuration
├── keyring-os/        # OS keyring metadata
├── keyring-file/      # File keyring (if used)
└── data/              # Local data cache

Environment Variables

All configuration can be set via environment variables with the XYZ_ prefix:

Variable	Description	Default
`XYZ_NODE`	RPC endpoint	`tcp://localhost:26657`
`XYZ_CHAIN_ID`	Chain ID	`xyz-testnet-1`
`XYZ_KEYRING_BACKEND`	Keyring backend	`os`
`XYZ_HOME`	Home directory	`~/.xyz`

Example:

export XYZ_NODE=tcp://rpc.testnet.xyz.com:26657
xyz balance mykey  # Uses testnet RPC

Configuration Precedence

Configuration values are resolved in this order (highest to lowest):

Command-line flags - --node tcp://...
Environment variables - XYZ_NODE=tcp://...
Config file - ~/.xyz/config.yaml
Default values - Built-in defaults

Updating

From Source

cd xyz
git pull
make install-cli

Check for Updates

xyz --version
# Compare with latest release on GitHub

Uninstalling

# Remove binaries
rm $(which xyz)
rm $(which xyzd)

# Remove data directory (optional)
rm -rf ~/.xyz

Troubleshooting

Command not found: xyz

Ensure $GOPATH/bin is in your PATH:

export PATH=$PATH:$(go env GOPATH)/bin

Add to your shell profile for persistence.

Permission denied

The binary may need executable permission:

chmod +x $(go env GOPATH)/bin/xyz

Build errors

Ensure Go 1.21+ is installed:

go version
# go version go1.21.x ...

Update Go if needed from https://go.dev/dl/

Missing dependencies

Run go mod tidy to fetch dependencies:

cd xyz
go mod tidy
make install-cli

Getting Started

Chain

Products

Developer Tools

Token Operations

Smart Contracts

Local Development

Chain API

Launchpad API

Installation

Installation

Prerequisites

Install from Source

Clone and Build

Install Both CLIs

Binary Locations

Verify Installation

Shell Completion

Configuration

Initial Setup

View Configuration

Directory Structure

Environment Variables

Configuration Precedence

Updating

From Source

Check for Updates

Uninstalling

Troubleshooting

Next Steps

Configuration

Key Management

​Installation

​Prerequisites

​Install from Source

​Clone and Build

​Install Both CLIs

​Binary Locations

​Verify Installation

​Shell Completion

​Configuration

​Initial Setup

​View Configuration

​Directory Structure

​Environment Variables

​Configuration Precedence

​Updating

​From Source

​Check for Updates

​Uninstalling

​Troubleshooting

​Next Steps

Configuration

Key Management

Installation

Prerequisites

Install from Source

Clone and Build

Install Both CLIs

Binary Locations

Verify Installation

Shell Completion

Configuration

Initial Setup

View Configuration

Directory Structure

Environment Variables

Configuration Precedence

Updating

From Source

Check for Updates

Uninstalling

Troubleshooting

Next Steps