Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

The fastest way to install Akshi is with the official install script:

curl -fsSL https://akshi.dev/install.sh | sh

The script downloads the correct binary for your platform and places it in /usr/local/bin by default.

Environment variables

VariableDefaultDescription
AKSHI_INSTALL_DIR/usr/local/binDirectory to install the akshi binary into
AKSHI_VERSIONlatestPin a specific release version (e.g. 0.4.2)
AKSHI_ALLOW_DOWNGRADEunsetSet to 1 to allow installing an older version than what is currently installed

Example – install a specific version to a custom directory:

AKSHI_INSTALL_DIR=~/.local/bin AKSHI_VERSION=0.4.2 \
  curl -fsSL https://akshi.dev/install.sh | sh

Supported platforms

OSArchitectureStatus
macOSx86_64Supported
macOSaarch64 (Apple Silicon)Supported
Linuxx86_64Supported

Windows support is not yet available. WSL2 with a supported Linux distribution works as a workaround.

Build from source

Building from source requires a recent Rust toolchain (stable) and the wasm32-wasip1 target.

# Clone the repository
git clone https://github.com/AkshiSystems/akshi.git
cd akshi

# Build the host CLI and runtime
cargo build --release

# Build the agent Wasm module
cargo build --target wasm32-wasip1 -p akshi-agent --release

The host binary is at target/release/akshi. The agent Wasm module is at target/wasm32-wasip1/release/akshi_agent.wasm.

If you do not already have the Wasm target installed:

rustup target add wasm32-wasip1

Verify the installation

akshi --version

You should see output like:

akshi 0.4.2

If the command is not found, make sure the install directory is on your PATH.

Next steps

Continue to the Quickstart to launch your first runtime.