stainless-code/Codemap

SQL-queryable structural index of your codebase. Run any predicate as a recipe; CI gating via SARIF → Code Scanning.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
working-directorySubdirectory to run codemap in (for monorepos). Defaults to the repository root.no.
package-managerOverride package-manager autodetect. Accepts npm | pnpm | yarn | yarn@berry | bun. Empty = autodetect via package-manager-detector (lockfile + packageManager field + devEngines.packageManager + install-metadata + parent-dir walk).no""
versionPin codemap CLI version (e.g. 1.2.3). Empty = use the project's devDependency if present, else fall back to <pm> dlx codemap@latest.no""
state-dirOverride codemap state directory location. Empty = .codemap/ at the working-directory root (codemap default).no""
modeRun shape: 'audit' | 'recipe' | 'aggregate' | 'command'. Default: 'audit' on pull_request events; ignored on other events (Action no-ops). 'aggregate' is reserved for v1.x — currently rejected.noaudit
recipeRecipe id (when mode=recipe). Use --recipes-json on the CLI to list known recipes.no""
paramsRecipe params for parametrised recipes (when mode=recipe). Multiline `key=value` pairs, one per line.no""
baselineSaved baseline name to diff against (when mode=recipe + a baseline was previously saved with --save-baseline).no""
audit-baseGit ref to audit against (when mode=audit). Empty (default) → falls back to `github.base_ref` on `pull_request` events; on other events the action no-ops unless an explicit `command:` is set.no""
changed-sinceFilter results to files changed since the given git ref (e.g. 'origin/main').no""
group-byBucket results by 'owner' (CODEOWNERS) | 'directory' | 'package' (workspace package). Empty = no bucketing.no""
commandRaw CLI args to invoke codemap with (escape hatch). When set, overrides mode / recipe / params / baseline / audit-base / changed-since / group-by — those are silently ignored with a warning.no""
formatOutput format: 'sarif' | 'json' | 'annotations' | 'mermaid' | 'diff' (per-mode availability varies; audit supports text/json/sarif). Default: 'sarif' (SARIF 2.1.0 → Code Scanning).nosarif
output-pathWhere to write the output file. Used as the artifact-upload source when format=sarif and upload-sarif=true.nocodemap.sarif
upload-sarifUpload the SARIF artifact to GitHub Code Scanning. Requires GitHub Advanced Security on private repos. Set 'false' if your repo can't use Code Scanning (still produces the artifact for manual download / pr-comment writer).notrue
pr-commentPost a markdown summary comment on the PR (Slice 3 — opt-in for v1.0). Set 'true' to enable. Useful when SARIF→Code-Scanning isn't available (private repos without GHAS, or repos that haven't enabled Code Scanning).nofalse
fail-onExit-code policy: 'any' | 'error' | 'warning' | 'never'. v1.0 ships only 'any' (fails when any finding) and 'never' (no exit code). 'error' / 'warning' deferred until per-recipe severity overrides ship.noany
tokenGitHub token for SARIF upload + PR comment posting. Empty (default) → falls back to `github.token` automatically. Pass an explicit fine-grained PAT only if you need elevated permissions.no""
namedescription
agentResolved package manager (npm / pnpm / yarn / yarn@berry / bun).
execShell-ready command used to invoke codemap.
install_methodHow codemap was located: 'project-installed' | 'dlx-pinned' | 'dlx-latest'.
output-filePath to the written output file (echoes inputs.output-path).