Skip to main content

Installation

Set up the Traceability Report Framework toolchain in a few minutes. The CLI is the fastest way to generate and inspect TWPack files locally; optional viewers and integrations can be added later.

Prerequisites​

  • macOS, Linux, or Windows 10/11
  • Shell access (Bash, PowerShell)
  • Internet connectivity for the initial install

Install the TRF CLI​

npm install -g @traceweave/trf

Verify the installation​

trf --version
# 0.1.0

Individual Packages (Optional)​

You can install packages separately for programmatic use or specific functionality:

# Validator only
npm install @traceweave/trf-validator

# Builder only
npm install @traceweave/trf-builder

# Analyzer only
npm install @traceweave/trf-analyzer

# Query only
npm install @traceweave/trf-query

One-time Use with npx​

Run TRF commands without installing globally:

npx @traceweave/trf validate my-pack.twpack

Install the Viewer (optional)​

Download the latest desktop viewer release from the TRF project page and follow the installer prompts for your platform:

  • Windows: .msi installer with signed binaries
  • macOS: .dmg image (drag app to Applications)
  • Linux: AppImage or .deb package

After installation:

trf-viewer my-pack.twpack

Next steps​