Appearance

Aleph Cloud Command-Line Interface ​

The Aleph Cloud CLI provides a powerful command-line interface to interact with all features of the Aleph.im network directly from your terminal.

Installation ​

Prerequisites ​

Before installing the CLI, ensure you have the necessary dependencies:

bash
apt-get install -y python3-pip libsecp256k1-dev
bash
brew tap cuber/homebrew-libsecp256k1
brew install libsecp256k1

We recommend using pipx to install the CLI:

bash
# Install pipx if you don't have it
python3 -m pip install --user pipx
python3 -m pipx ensurepath

# Install Aleph CLI
pipx install aleph-client

Alternative Installation Methods ​

bash
python3 -m venv aleph-env
source aleph-env/bin/activate
pip install aleph-client
bash
docker run --rm -ti \
    -v $(pwd)/data:/data \
    ghcr.io/aleph-im/aleph-client/aleph-client:master \
    --help

INFO

⚠️ Using Docker will create an ephemeral key that will be discarded when the container stops.

Command Overview ​

The Aleph CLI is organized into logical command groups that correspond to different Aleph.im features:

CommandDescription
accountManage accounts, keys, and balances
messageCreate, find, and manage messages
aggregateWork with aggregate messages and permissions
fileUpload, pin, and manage files on IPFS
programDeploy and manage serverless functions
instanceCreate and manage virtual machine instances
domainConfigure custom domains for your deployments
nodeGet information about network nodes
pricingView pricing for Aleph.im services

Getting Started ​

First-time Setup ​

When using the CLI for the first time, you'll need to create or import a private key:

bash
# Create a new Ethereum private key
aleph account create

# Import an existing private key
aleph account create --private-key YOUR_PRIVATE_KEY

Checking Your Configuration ​

Verify your setup is working correctly:

bash
# Show your account configuration
aleph account show

# Display your public address
aleph account address

# Check your ALEPH token balance
aleph account balance

Troubleshooting ​

If you encounter issues with the CLI:

  • Ensure you have the latest version: pip install -U aleph-client
  • Check that your private key is correctly configured: aleph account show
  • For permission errors, verify you have the correct permissions for the operation
  • If you find a bug, please report an issue

Next Steps ​

Explore the detailed documentation for each command group:

Version loading...