Skip to content

slimctl

The slimctl command-line tool for operating SLIM. It lets you start and manage SLIM nodes, inspect connections and routes, manage Controller configuration, and interact with the Channel Manager — all from a single binary.

Usage

slimctl [OPTIONS] <COMMAND>

Commands

Command Aliases Description
slim s Start and manage a local SLIM node
node n, instance, i Interact directly with a SLIM node
controller c, ctrl Interact with the SLIM Control Plane
channel-manager cm Interact with the Channel Manager
bench Benchmark SLIM messaging performance
config Manage slimctl client configuration
version Print version and build information

Options

Flag Short Default Description
--config ~/.slimctl/config.yaml Path to slimctl configuration file
--server (varies by command) gRPC API endpoint (host:port)
--timeout 15s gRPC request timeout (e.g. 30s, 1m)
--basic-auth-creds -b Basic auth credentials (username:password)
--tls.ca_file Path to TLS CA certificate
--tls.cert_file Path to client TLS certificate
--tls.key_file Path to client TLS private key
--tls.insecure_skip_verify false Use TLS but skip certificate verification

The default value of --server depends on which command is used:

Command Default server
slim, node 127.0.0.1:46358
controller 127.0.0.1:50051
channel-manager 127.0.0.1:10356

Most options can also be set via environment variables or a config file.