Skip to main content

Development Setup

Follow these steps to get the ADM codebase running on your local machine.

Requirements​

Clone and install​

git clone https://github.com/mitre-attack/attack-data-model.git
cd attack-data-model
npm install

💡 The repo is a multi-package workspace (core library + docusaurus site). Running npm install at the root will NOT install the dependencies for building the docs. Check out the documentation contribution guide for more details.

Verify TypeScript build​

npm run build  # compiles src → dist using tsup
npm run test # vitest tests

Handy npm scripts​

ScriptPurpose
npm run lintLints all src/** files
npm run formatPrettier + ESLint fix
npm run testRun tests

You are now ready to hack on the library. Continue with Coding Style & Linting for the mandatory style rules.