Skip to content

syncropic/syncropel-cli

Repository files navigation

spl

The Syncropel CLI and local developer registry.

Full governance stack on your machine. Offline-first, persistent, production-compatible. Same API as the production registry — SDKs connect identically. Agent-friendly: progressive discovery, self-installing integrations, JSON output on every command.

Install

curl -fsSL https://get.syncropic.com/spl | sh

Or install manually:

# With pipx (recommended)
pipx install "syncropel-cli[serve] @ git+https://github.com/syncropic/syncropel-cli.git@v0.3.0"

# With uv
uv tool install "syncropel-cli[serve] @ git+https://github.com/syncropic/syncropel-cli.git@v0.3.0"

# With pip
pip install "syncropel-cli[serve] @ git+https://github.com/syncropic/syncropel-cli.git@v0.3.0"

# From source
git clone https://github.com/syncropic/syncropel-cli.git
cd syncropel-cli && uv sync --extra dev

Requires Python 3.12+.

Quick Start

spl serve                          # Start the local registry
spl namespace create myproject -j  # Create a governed namespace
spl policy set myproject -j        # Set capability policies
spl trust show -j                  # View trust scores
spl trace ls -j                    # List traced sessions

spl serve auto-configures the CLI to point at localhost:9100. No manual config needed.

Open Syncropel Studio to operate the registry from the browser.

Commands

Group Commands
serve spl serve — start local registry
trace ls, show, stats, risk, pattern — browse execution sessions
namespace create, ls, show, resolve, delete, use, bind, unbind — manage the namespace hierarchy
policy set, show — capability, deny, and budget policies
trust show, compute — Wilson-score trust with temporal decay
observe record — record governance observations
auth sa-create, sa-list, sa-revoke, sa-rotate, whoami — service accounts
federation consent-add, consent-list, consent-revoke — consent-gated evidence sharing
hitl pending, approve, deny — human-in-the-loop approval
settlement execute, verify — governance settlement
audit query — governance audit trail
config show, path, validate — CLI configuration
setup --claude-code, --hooks, --all — self-installing integrations
init generate .syncropel/ discovery files
help-agent progressive discovery for AI agents

All commands support -j / --json for structured JSON output.

For AI Agents

# Progressive discovery — compact, token-budgeted
spl help-agent -j                   # Command overview
spl help-agent trace -j              # Group details
spl help-agent --conventions -j      # Governance model

# Self-installing integrations
spl setup --all                      # Install skill file + trace hooks

# Actor identity
export SPL_ACTOR=claude-agent        # Identify yourself in audit logs

# Project discovery files
spl init                             # Generate .syncropel/ABOUT.md + CONVENTIONS.md

Local Registry

spl serve starts a DuckDB-backed local registry implementing the full Syncropel governance stack:

localhost:9100
├── Patterns, Observations, Namespaces
├── Governance Engine (deterministic validator)
├── Trust Computation (Wilson score, temporal decay)
├── SCT Issuance (capability/deny/budget/dial envelopes)
├── Federation Consent Graph
├── HITL Approval Workflow
├── Settlement Execution
└── Audit Trail

The API is identical to the production registry. SDKs configured with registry_url="http://localhost:9100" work the same as against registry.syncropel.com.

Configuration

Layered, lowest to highest priority:

  1. Built-in defaults — sensible out of the box
  2. Config file~/.syncropel/config.yaml
  3. Environment variables — override everything
Variable Default Description
SPL_HOME ~/.syncropel Syncropel home directory
SPL_REGISTRY_URL auto-configured Registry URL (set by spl serve)
SPL_ACTOR Actor identity for audit logs
AUTH_PROVIDER dev for local development

Development

uv sync --extra dev              # Install with dev dependencies
uv run pytest tests/ -v          # Run tests
uv run ruff check src/ tests/    # Lint
uv run ruff format --check src/ tests/
uv run spl --help                # Run CLI

Related

License

Apache-2.0. See LICENSE.

About

spl — the Syncropel CLI and local developer registry. Full governance stack on your machine. Offline-first, agent-friendly, production-compatible.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors