Transiever.SieveRuler.Cli 1.1.5

srtx

This guide is the canonical command reference for the SieveRuler CLI. See the SieveRuler project overview, synchronization policy, and rules and metadata guide.

Install

dotnet tool install --global Transiever.SieveRuler.Cli

The global-tool package is available on NuGet.org. For a workflow overview and local Sieve export path, see Generate and deploy Sieve rules from JSON in .NET.

Commands:

srtx inspect --rules rules.json
srtx optimize balanced --rules rules.json
srtx generate --rules rules.json --sieve rules.sieve
srtx preview --rules rules.json --preserve-compatible
srtx deploy --plan deployment-plan.json
srtx deploy --plan deployment-plan.json --history-limit 3
srtx deploy --plan deployment-plan.json --no-prune-history
srtx rollback --plan deployment-plan.json
srtx history list
srtx history show srtx-backup-20260626121421-example --sieve restored.sieve
srtx history restore latest
srtx history restore original
srtx history delete srtx-20260626121421-example
srtx history prune --dry-run

During development, replace srtx with:

dotnet run --project src/Transiever.SieveRuler.Cli --

Install the self-contained Linux x64 build with Homebrew:

brew install SeWieland/transiever/srtx

GitHub releases attach self-contained srtx assets for win-x64, win-x86, and linux-x64. .NET does not define a portable linux-x86 RID, so no Linux x86 asset is produced.

Optimization modes:

• conservative merges exact single-condition equivalents.
• balanced also merges action-equivalent single-condition rules across condition types and uses higher-confidence sender-domain inference.
• aggressive keeps balanced merge behavior and applies broader sender-domain inference and subdomain collapse.

Preview writes these artifacts without mutating the server:

• reconciled-rules.json.

• candidate-rules.json.

• server-active.sieve.

• candidate.sieve.

• deployment-plan.json.

• reconciled-rules.json is the ownership review document.

• candidate-rules.json contains the managed rules rendered into the candidate script.

If the server has an active script, preview targets that script name by default. Use --script-name <name> to override the target explicitly.

Generated managed rules include provider UI metadata comments in the Open-Xchange/mailbox.org ## Flag: style. The CLI remains provider-agnostic in intent. However, this metadata shape is currently validated against mailbox.org's Open-Xchange implementation.

Canonical workflow and policy details live in the synchronization policy. This file keeps the command-facing behavior and operator guidance.

Deployment validates the exact previewed candidate and active-script snapshot. When the target is the current active script, deployment writes a server-side srtx-backup-* copy of the previous content. It then replaces the active script in place.

When the target is not active, deployment uploads and activates it. After a successful deployment, srtx prunes inactive history scripts in SieveRuler's reserved history namespace. Pruned names match srtx-YYYYMMDDHHMMSS-* or srtx-backup-YYYYMMDDHHMMSS-*. Matching names are managed regardless of who created them.

The default retention keeps the oldest backup plus the newest 5 remaining history scripts.

Use --history-limit <count> to change the newest-history count. Use --no-prune-history to disable deletion. If HAVESPACE fails before upload, deployment runs the same safe prune pass, refreshes state, and retries the quota check once.

Rollback validates the plan and current active candidate before changing the server. Plans with a server-side backup restore that backup into the target script. Plans without a backup reactivate the recorded source script. They disable active Sieve processing if the preview started with no active script.

--force bypasses only the current-active candidate mismatch check. Backup and content hash validation still apply.

History commands work directly from retained server scripts in SieveRuler's reserved history namespace.

history list shows srtx-backup-* backups and srtx-* candidates, marking the oldest backup or no-active marker as original. history show <name> prints the retained script or writes it with --sieve. history restore <name>, history restore latest, or history restore original creates a fresh backup of the current active state before restoring. latest resolves to the newest inactive srtx-backup-* script. If original is a srtx-backup-*-no-active marker, it disables active Sieve processing. history delete <name> removes one inactive history script in SieveRuler's reserved history namespace and refuses to delete the active script. history prune deletes all inactive history scripts in SieveRuler's reserved history namespace, including the original backup or no-active marker. It keeps the active script and script names outside SieveRuler's reserved history namespace. Use --dry-run with delete or prune to validate without mutating the server.

ManageSieve configuration:

TRANSIEVER_SIEVE_HOST=sieve.example.com
TRANSIEVER_SIEVE_PORT=4190
TRANSIEVER_SIEVE_USERNAME=user@example.com
TRANSIEVER_SIEVE_PASSWORD=secret
TRANSIEVER_SIEVE_SECURITY_MODE=StartTlsRequired

Use --sieve-host, --sieve-port, --sieve-username, --sieve-password, and --sieve-security-mode to override those values for a targeted command. The port and security mode are optional. ImplicitTls is supported. Plaintext authentication is refused. Missing passwords are prompted only on an interactive terminal.