Skip to content

Aleph Command Line Interface

Access all the features of from your terminal using the aleph-client command-line interface.


On Linux:

apt-get install -y python3-pip libsecp256k1-dev

On macOS:

brew tap cuber/homebrew-libsecp256k1
brew install libsecp256k1


Install aleph-client from PyPI using pip:

pip install aleph-client


Explore the available commands from the help menu:

aleph --help

 Usage: aleph [OPTIONS] COMMAND [ARGS]...                                                                  

╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────╮
 --install-completion        [bash|zsh|fish|powershell|pwsh]  Install completion for the specified                                                                     shell.                                                                                                   [default: None]                             --show-completion           [bash|zsh|fish|powershell|pwsh]  Show completion for the specified shell,                                                                 to copy it or customize the installation.                                                                [default: None]                             --help                                                       Show this message and exit.                ╰─────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────────╮
 about             Display the information of Aleph CLI                                                  account           Manage account                                                                         aggregate         Manage aggregate messages on                                                  domain            Manage custom Domain (dns) on                                                 file              File uploading and pinning on IPFS and                                        instance          Manage instances (VMs) on network                                             message           Post, amend, watch and forget messages on                                     node              Get node info on network                                                      program           Upload and update programs on VM                                             ╰─────────────────────────────────────────────────────────────────────────────────────────────────────────╯

Or check out the documentation page.

Test using Docker

Use the client from within Docker or Podman with:

docker run --rm -ti -v $(pwd)/data:/data --help

⚠️ This will use an ephemeral key that will be discarded when stopping the container.