Skip to content

Repository files navigation

SOFE CLI

Command-line interface for the SOFE Open FinOps Engine
19 commands, interactive TUI, AI-powered remediation.

Quick Start · Commands · v0.3 Features · Ecosystem

LicenseGoLocal + CloudPRs


Evaluate FinOps policies, browse findings in an interactive TUI, get AI-powered remediation commands — all from your terminal.

# Quick install (macOS/Linux)
curl -fsSL https://sofe.dev/install.sh | bash
# Evaluate your AWS account
sofe evaluate --profile default --policies ./policies/

Install

# Quick install (macOS/Linux)
curl -fsSL https://sofe.dev/install.sh | bash
# Go install
go install github.com/breakingthecloud/sofe-cli@latest
# Or download binary from GitHub Releases# https://github.com/breakingthecloud/sofe-cli/releases

Quick Start

Local Mode

# Start the local evaluation server
sofe serve
# Evaluate policies against your AWS account
sofe evaluate --profile default --policies ./policies/
# With auto-start server
sofe evaluate --auto-serve --profile default

Cloud Mode

# Set your API key (get one at platform.sofe.dev)
sofe config set api-key sk_sofe_your_key_here
# Evaluate via cloud
sofe evaluate --cloud
# Or pass key directly
sofe evaluate --cloud --api-key sk_sofe_xxx

Commands

Core

CommandDescription
sofe evaluateRun policies against AWS resources (spinner + summary card)
sofe interactiveSplit-panel TUI (findings + detail + AI)
sofe historyList past evaluations (cloud mode)
sofe watchMonitor with live sparkline + change detection

AI + Remediation

CommandDescription
sofe explainAI explanation for a specific finding
sofe remediateShow/execute remediation CLI commands
sofe topFindings ranked by frequency
sofe diffCompare two evaluations (new/fixed/unchanged)

Account

CommandDescription
sofe loginAuthenticate via browser (device flow)
sofe upgradeConnect to SOFE Cloud or upgrade to Pro
sofe statusShow account status (tier, evals, AI usage)
sofe configManage configuration (set/show)

Utilities

CommandDescription
sofe serveStart local evaluation server (port 8080)
sofe policiesList available policies
sofe changelogShow release notes
sofe versionBuild info (commit, date, Go, OS)
sofe terraformScan Terraform plans
sofe completionShell autocompletion (bash/zsh/fish)

New in v0.3.0

Interactive TUI

sofe interactive # Browse findings with keyboard navigation
sofe interactive abc123-eval-id # Or specify an evaluation

Navigate with ↑/↓, press Enter for details, e for AI explanation, q to quit.

AI Explain & Remediate

sofe explain abc123-eval-id --finding 2 # AI explanation
sofe remediate abc123-eval-id --finding 2 # Show remediation commands
sofe remediate abc123-eval-id --finding 2 --execute # Execute interactively

Upgrade & Status

sofe upgrade # Connect CLI to SOFE Cloud
sofe upgrade pro # Upgrade to Pro tier
sofe status # Check your status

Evaluate Flags

FlagDescription
--cloudUse cloud API instead of local server
--api-keyAPI key for cloud mode
--profileAWS profile (local mode)
--policiesPolicies directory
--fail-onExit 1 if findings at/above severity
--resource-typesFilter resource types (comma-separated)
--auto-serveAuto-start local server if not running
--formatOutput format (table|json|markdown)

Configuration

sofe config show # Show current config
sofe config set mode cloud # Default to cloud mode
sofe config set api-key sk_sofe_xxx # Persist API key
sofe config set profile my-profile # AWS profile for local mode
sofe config set format json # Output format

Config stored at ~/.sofe/config.yaml (permissions 0600).

Environment variables: SOFE_API_KEY, SOFE_CLOUD_URL.

Local vs Cloud

LocalCloud
Needssofe-server running locallyAPI key from platform.sofe.dev
AuthNone (localhost)X-API-Key header
AWS accessYour local credentialsConnected account (IAM role)
Rate limitNone10/day (free), 1000/day (pro)
HistoryNoneStored in platform

CI/CD

# Block deploys with critical findings
sofe evaluate --cloud --api-key $SOFE_API_KEY --fail-on high

Ecosystem

ProjectDescription
sofePython engine (collectors + policies)
sofe-serverREST API server
sofe-actionGitHub Action
platform.sofe.devSaaS dashboard (free tier)
sofe.dev/docsDocumentation

License

Apache 2.0 — see LICENSE.


sofe.dev · Engine · finoptix.dev

19 commands. Zero AWS bill surprises.

About

SOFE command-line interface — run FinOps evaluations from your terminal.

Topics

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages