dtk

dtk is a CLI scaffolding tool for generating self-contained TypeScript runbook projects. Run a command, get a project. Add plugins for AWS, Redis, SQL, and more. Write runbooks as plain TypeScript files and run them with a single npm script. Your generated project has no ongoing dependency on dtk -- you own all the files from the moment they are created.

This repository contains the dtk CLI tool and a reference example of a project generated by it.

Quick start

npm install -g @jordanalec/dtk

mkdir my-project && cd my-project
dtk init
npm install
npm run runbook:example

See dtk/README.md for the full CLI reference, available plugins, and how to write runbooks.

Structure

dtk/        the CLI tool, published to npm as `dtk`
example/    a project generated by `dtk init`, showing the tool in use
tools/      local Docker services for testing (Redis, Postgres)

example

cd example
npm install
npm run runbook:example

tools

Local Docker services for spinning up Redis, Postgres, and MongoDB when testing the example project or runbooks locally. See tools/README.md for usage.