Skip to content

SLIM CLI Installation

slimctl is a command-line tool for managing SLIM Nodes and Controllers. It supports local development, route management, connection monitoring, and direct node access.

Pre-built Binaries

Download the binary for your platform from the GitHub releases page.

curl -LO https://github.com/agntcy/slim/releases/download/slimctl-v2.0.0/slimctl-darwin-arm64.tar.gz
tar -xzf slimctl-darwin-arm64.tar.gz
sudo mv slimctl /usr/local/bin/slimctl
sudo chmod +x /usr/local/bin/slimctl

macOS Security

You may need to allow the binary to run if blocked by Gatekeeper:

sudo xattr -rd com.apple.quarantine /usr/local/bin/slimctl

Alternatively, go to System Settings > Privacy & Security and allow the application when prompted.

curl -LO https://github.com/agntcy/slim/releases/download/slimctl-v2.0.0/slimctl-darwin-amd64.tar.gz
tar -xzf slimctl-darwin-amd64.tar.gz
sudo mv slimctl /usr/local/bin/slimctl
sudo chmod +x /usr/local/bin/slimctl

macOS Security

You may need to allow the binary to run if blocked by Gatekeeper:

sudo xattr -rd com.apple.quarantine /usr/local/bin/slimctl

Alternatively, go to System Settings > Privacy & Security and allow the application when prompted.

curl -LO https://github.com/agntcy/slim/releases/download/slimctl-v2.0.0/slimctl-linux-amd64-gnu.tar.gz
tar -xzf slimctl-linux-amd64-gnu.tar.gz
sudo mv slimctl /usr/local/bin/slimctl
sudo chmod +x /usr/local/bin/slimctl

curl -LO https://github.com/agntcy/slim/releases/download/slimctl-v2.0.0/slimctl-linux-arm64-gnu.tar.gz
tar -xzf slimctl-linux-arm64-gnu.tar.gz
sudo mv slimctl /usr/local/bin/slimctl
sudo chmod +x /usr/local/bin/slimctl

Invoke-WebRequest -Uri "https://github.com/agntcy/slim/releases/download/slimctl-v2.0.0/slimctl-windows-amd64.zip" -OutFile "slimctl.zip"
Expand-Archive -Path "slimctl.zip" -DestinationPath "."

# Move to a directory in your PATH (e.g., C:\Program Files\slimctl\)

Alternatively, download directly from the releases page.

Invoke-WebRequest -Uri "https://github.com/agntcy/slim/releases/download/slimctl-v2.0.0/slimctl-windows-arm64.zip" -OutFile "slimctl.zip"
Expand-Archive -Path "slimctl.zip" -DestinationPath "."

# Move to a directory in your PATH (e.g., C:\Program Files\slimctl\)

Alternatively, download directly from the releases page.

Homebrew (macOS)

brew tap agntcy/slim https://github.com/agntcy/slim.git
brew install slimctl

Building from Source

Prerequisites: Rust toolchain (the workspace pins a specific version via rust-toolchain.toml)

# From repository root
cargo build -p agntcy-slimctl --release

# Binary location: target/release/slimctl

Or run directly without installing:

cargo run --bin slimctl -- help

Verify Installation

slimctl version

Configuration

slimctl reads its configuration from:

  • $HOME/.slimctl/config.yaml
  • ./config.yaml (current directory)
  • Via --config flag

An example config.yaml for connecting to a Controller:

endpoint: "127.0.0.1:46358"
connect_timeout: "10s"
request_timeout: "10s"
tls:
  insecure: false
  ca_source:
    type: file
    path: "/path/to/ca.pem"
  source:
    type: file
    cert: "/path/to/client.pem"
    key: "/path/to/client.key"

Next Steps