Quickstart

Installation

Prerequisites

• Rust Nightly with Cargo
• Terminal for accessing TypeDown via its command line interface (CLI)
• Text Editor
  • VSCode is recommended, along with the official extension

TypeDown can be used as a standalone tool or integrated as a dependency in an existing Rust project. For standalone installation, run:

cargo

$ cargo install --git https://github.com/MordragT/type-down

Embedding

Prerequisites

• Rust Nightly with Cargo

To integrate TypeDown into your existing Rust project, either run the command below or manually add it to your Cargo.toml file:

cargo

$ cargo add --git https://github.com/MordragT/type-down