DeploySense Documentation

Getting Started

Install dependencies, build the workspace, then scan a config file.

pnpm install
pnpm build
npx deploysense scan Dockerfile

CLI Reference

deploysense scan <file-or-path> [--json] [--markdown] [--sarif] [--fail-on high]
deploysense doctor <logfile>
deploysense list-rules
deploysense init
deploysense fix Dockerfile --yes

Web Scanner

The scanner workspace supports Dockerfile, YAML workflows, Kubernetes manifests, Docker Compose, and deployment logs. The full-stack example runs a project scan so you can inspect cross-file architecture links, not only single-file rule hits.

Architecture Graph

Project scans connect CI workflows, Dockerfiles, image references, Kubernetes workloads, services, ingresses, and Docker Compose dependencies. DeploySense then reports architecture insights such as mutable image chains, weak runtime health signals, missing deployment pipelines, and build/runtime linkage gaps.

curl -X POST "$NEXT_PUBLIC_API_URL/api/scan/project" \
  -H "Content-Type: application/json" \
  -d '{"files":[{"name":"Dockerfile","content":"FROM node:latest"}]}'

GitHub Action

- uses: actions/checkout@v4
- uses: ./packages/github-action
  with:
    scan-path: .
    fail-on: high
    comment-pr: true

Scanner Rules

DeploySense ships 54+ configuration and architecture checks across security, reliability, performance, cost, maintainability, and CI/CD quality.

Contributing

Add a rule by creating a Rule object, exporting it from the scanner package, and adding a fixture-driven test.

Roadmap

  • More cloud-native scanners.
  • Persistent report storage.
  • VS Code marketplace release.