sato

(โ˜… 109)

Sato converts ARM or CFN into Terraform

  • .checkov.yaml
  • .codecov.yml
  • .gitignore
  • .golangci.yml
  • .goreleaser.yml
  • .markdownlint.json
  • .pre-commit-config.yaml
  • ARCHITECTURE.md
  • bump.ps1
  • bump.sh
  • CONTRIBUTING.md
  • Dockerfile
  • entrypoint.sh
  • go.mod
  • go.sum
  • INTRINSIC_FUNCTIONS.md
  • LICENSE
  • main.go
  • Makefile
  • README.md
  • SECURITY.md
  • todo.txt

# Installation Guide

1. Get the code
git clone https://github.com/JamesWoolfenden/sato

Downloads the entire project code from GitHub to your computer.

cd sato

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
  • Scoop A package manager for Windows.
brew tap jameswoolfenden/homebrew-tap

Registers this project's repository (tap) with Homebrew.

brew install jameswoolfenden/tap/sato

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

scoop install sato

Installs directly via Scoop (Windows).

โœ… 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 pull jameswoolfenden/sato

Type this command into your terminal and run it.

docker run --tty --volume /local/path/to/tf:/tf jameswoolfenden/sato scan -d /tf

Runs the built image as an actual container.

- [Docker](#docker)

Type this command into your terminal and run it.

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

Pulled directly from this repo's README.

4. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
go install

Type this command into your terminal and run it.

3:51PM INF promoted aws_scheduler_schedule.template; run `go build ./...` to verify

Compiles the Go program into an executable.

โœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

Pulled directly from this repo's README.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

โœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation