cloudburn

(β˜… 1,777)

Open-source policy engine that blocks bad AWS spending patterns before they ship and remediates what's already burning.

  • .gitignore
  • .npmrc
  • .nvmrc
  • AGENTS.md
  • biome.jsonc
  • CLAUDE.md
  • CONTRIBUTING.md
  • LICENSE
  • package.json
  • pnpm-lock.yaml
  • pnpm-workspace.yaml
  • README.md
  • skills-lock.json
  • tsconfig.base.json
  • turbo.json

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/towardsthecloud/cloudburn

Downloads the entire project code from GitHub to your computer.

cd cloudburn

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
  • Node.js Node.js must be installed to use npm.
brew install towardsthecloud/tap/cloudburn

Installs the pre-built package via Homebrew β€” no source build required.

npm install --global cloudburn

Installs the package published on the npm registry globally β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f deploy/docker-compose.yml up -d --build

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install --global cloudburn

Installs the package published on the npm registry globally β€” no need to clone the source.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation