Get started with CCE
Install the CLI, run a scan from your project root, and explore recipe packs for modernization and CI gates.
Install
brew tap stackgenhq/homebrew-stackgen
brew install stackgenhq/homebrew-stackgen/cce
cce -version
One-liners
Run from your project root. By default CCE honors .gitignore (skips vendor/).
| Goal | Command |
|---|---|
| Preview files | cce plan -folder . -language AUTO |
| Cloud entitlements | cce -folder . -language AUTO -filter cloud -format json -output cloud.json |
| Modernization pack | cce run -folder . -language AUTO -pack modernization-pack -output pack.json |
| List recipes | cce catalog |
| CI gate | cce diff baseline.json current.json --fail-new |
| SARIF for PRs | cce -folder . -filter cloud -format sarif -output findings.sarif |
What to use where
| You need | Use | Not |
|---|---|---|
| One cloud report | cce -filter cloud … |
Three separate scans |
| Cloud + SDK + tech-debt | cce run -pack modernization-pack |
Shell loop of cce commands |
| Specific built-in recipes | cce run -recipes cloud-entitlements,sdk-uplift |
Multiple full re-parses |
| Custom matching rules | -mapper-file ./my-lens.yaml + -filter all |
-filter cloud alone |
| Vendored SDK audit | -include-gitignored |
Default scan |
Recipe packs
Parse the repository once, then apply several lenses:
cce catalog
cce run -folder . -language AUTO -pack modernization-pack -output pack.json
Or pick recipes à la carte:
cce run -folder . -language AUTO -recipes sdk-uplift,tech-debt-inventory -output subset.json
Custom lenses
Pass a local YAML file or any HTTPS URL CCE can fetch. Use -filter all for non-cloud providers (tech-debt, CVE, etc.):
cce -folder . -language AUTO -filter all \
-mapper-file ./my-lens.yaml \
-format json -output findings.json
Use case catalog
Browse all workflows (modernization, security, governance, SRE, AI) with example commands and links to full guides.
List registered recipes:
cce catalog
cce run -folder . -language AUTO -pack modernization-pack -output pack.json
Related docs
| Topic | Page |
|---|---|
| Custom lens YAML | Grok rules, prefixes, data tables |
| Analysis recipes | Catalog schema, packs, cce run, CI policies |
| Cloud entitlements | Built-in PoLP scan |
| Platform adoption | Direct cloud SDK vs internal platform SDK lens template |
| Known limitations | Facades, languages, static analysis bounds |
Platform engineering and IAM teams:
- Enterprise lenses & catalogs — internal IDP libraries, private catalogs
- Entitlements, operations & IAM — S3 read/write, PoLP aggregation