Skip to main content
The Sigilum CLI (sigilum) is the primary tool for managing Sigilum infrastructure, gateway operations, service configuration, and OpenClaw integration.

​
Installation

​
Quick Install (Managed Mode)

Install from GitHub releases: 
curl -fsSL https://github.com/PaymanAI/sigilum/releases/latest/download/install-curl.sh | bash
Reload your shell: 
source ~/.zshrc  # or ~/.bashrc
Verify installation: 
sigilum version

​
Install from Source (Development)

Clone and install from the repository: 
git clone https://github.com/PaymanAI/sigilum.git
cd sigilum
./sigilum install
source ~/.zshrc

​
Installation Options

The curl installer accepts several options: 
curl -fsSL ... | bash -s -- [options]
  • --prefix <path> - Install location (default: ~/.sigilum)
  • --repo <owner/name> - GitHub repo override (default: PaymanAI/sigilum)
  • --version <tag> - Install a specific version (default: latest)
  • --tarball-url <url> - Install from explicit tarball URL
  • --checksum <sha256> - Expected SHA-256 for tarball verification
  • --release-pubkey-file <path> - PEM public key for signature verification
  • --require-signature - Require release checksum signature verification
The source installer (./sigilum install) supports:
  • --bin-dir <path> - Symlink destination (default: ~/.local/bin)
  • --rc-file <path> - Shell rc file to update (auto-detected by default)
  • --with-alias - Add alias sigilum="<repo>/sigilum" to rc file

​
Global Options

Global options must be specified before the command: 
sigilum [global-options] <command> [args]
OptionEnvironment VariableDescription
--namespace <value>GATEWAY_SIGILUM_NAMESPACESet the target namespace
--sigilum-home <path>GATEWAY_SIGILUM_HOMEGateway home directory
--gateway-admin-url <url>GATEWAY_ADMIN_URLGateway admin endpoint URL
--gateway-data-dir <path>GATEWAY_DATA_DIRGateway data directory
--gateway-master-key <value>GATEWAY_MASTER_KEYGateway master encryption key
--api-port <port>API_PORTAPI server port
--gateway-port <port>GATEWAY_PORTGateway server port
--native-port <port>NATIVE_PORTNative service port
--upstream-port <port>UPSTREAM_PORTUpstream service port
-v, --version-Show version information
-h, --help-Show help message

​
Namespace Configuration

If neither GATEWAY_SIGILUM_NAMESPACE nor SIGILUM_NAMESPACE is set, Sigilum loads a default namespace from ~/.sigilum/config.env. Example ~/.sigilum/config.env: 
SIGILUM_NAMESPACE=johndee
SIGILUM_API_URL=https://api.sigilum.id

​
Commands Overview

​
Core Commands

CommandDescription
sigilum versionShow sigilum version
sigilum versionsShow all component versions
sigilum installInstall sigilum command into your shell
sigilum help [command]Show help for a command

​
Gateway Commands

CommandDescription
sigilum gateway startStart the Sigilum gateway
sigilum gateway connectOne-command managed onboarding
sigilum gateway pairStart pairing bridge for dashboard

​
OpenClaw Commands

CommandDescription
sigilum openclaw connectOne-command OpenClaw onboarding
sigilum openclaw installInstall Sigilum hooks/skills
sigilum openclaw uninstallRemove Sigilum from OpenClaw
sigilum openclaw statusShow OpenClaw installation status

​
Authentication Commands

CommandDescription
sigilum auth loginBootstrap namespace-owner JWT token
sigilum auth refreshRefresh local JWT token
sigilum auth showDisplay stored JWT token
sigilum loginAlias for sigilum auth login

​
Service Management

CommandDescription
sigilum service addRegister a service
sigilum service listList registered services
sigilum service secret setUpdate service credentials

​
Development Commands

CommandDescription
sigilum upStart local API + gateway
sigilum downStop local services
sigilum doctorValidate local setup
sigilum e2e-testsRun end-to-end tests
sigilum agent-simulatorRun agent auth simulator

​
Version Information

Show the current Sigilum version: 
sigilum version
Output: 
sigilum 1.0.0
Show all component versions: 
sigilum versions
Output: 
Sigilum Component Versions
  sigilum                  1.0.0
  root                     1.0.0
  apps                     1.0.0
  api                      1.0.0
  gateway                  1.0.0
  dashboard                1.0.0
  openclaw                 1.0.0
  ...

​
Getting Help

Show top-level help: 
sigilum --help
Show command-specific help: 
sigilum gateway --help
sigilum openclaw install --help
sigilum service add --help

​
Next Steps

Gateway Commands

Learn how to manage the Sigilum gateway

OpenClaw Integration

Integrate Sigilum with OpenClaw agents

Service Management

Add and manage services

Authentication

Manage namespace-owner credentials

Build docs developers (and LLMs) love

Get started for freeTalk to us