cdk-dia

(β˜… 973)

Automated diagrams of CDK provisioned infrastructure

  • .eslintignore
  • .eslintrc.js
  • .gitignore
  • .tool-versions
  • AGENTS.md
  • babel.config.json
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • FUNDING.yml
  • index.ts
  • jest.config.js
  • LICENSE
  • package-lock.json
  • package.json
  • README.md
  • testSetup.js
  • tsconfig.json

# Installation Guide

1. Get the code
git clone https://github.com/pistazie/cdk-dia

Downloads the entire project code from GitHub to your computer.

cd cdk-dia

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
brew install graphviz

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

βœ… 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. 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 cdk-dia

Downloads and installs the libraries listed in package.json.

npm install cdk-dia -g

Downloads and installs the libraries listed in package.json.

βœ… 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