Skip to content

Fix README Installation: document mitre/atomic, not the AtomicCaldera fork#64

Merged
deacon-mp merged 2 commits into
masterfrom
fix/readme-installation-instructions
May 20, 2026
Merged

Fix README Installation: document mitre/atomic, not the AtomicCaldera fork#64
deacon-mp merged 2 commits into
masterfrom
fix/readme-installation-instructions

Conversation

@deacon-mp
Copy link
Copy Markdown
Contributor

Problem

The README's recent rewrite (2026-04-27 → 04-30) reintroduced setup instructions for the old third-party xenoscr/atomiccaldera project rather than this plugin (mitre/atomic). Every step in the Installation/Dependencies sections was inaccurate. Verified against the actual code:

README said Reality in mitre/atomic
clone xenoscr/atomiccaldera, add atomiccaldera to plugins should be mitre/atomicplugins/atomic, enable atomic
pip install -r requirements.txt no requirements.txt exists in the repo
manually git clone redcanaryco/atomic-red-team done automatically on first enable — clone_atomic_red_team_repo() (app/atomic_svc.py:42-52)
git clone mitre/cti + STIX2 dep not used; enterprise-attack.json is bundled inside the atomic-red-team repo and read directly (app/atomic_svc.py:111). stix2 is never imported
edit conf/artconf.yml no conf/ dir, no artconf reference anywhere in code

Change

  • Rewrites Installation to the standard CALDERA plugin flow: clone into plugins/, enable in conf/local.yml, restart — data is auto-fetched on first load.
  • Trims Dependencies/Requirements to what's actually needed (git on PATH; Python deps from CALDERA core).
  • Leaves Overview, Known Limitations, Getting Started, and the Additional Note untouched.

Validation

  • grep -rni artconf → only the README; no conf/ directory.
  • grep -rni mitre/cti / cti.git → only the README; code reads bundled enterprise-attack.json.
  • enterprise-attack.json confirmed present in redcanaryco/atomic-red-team/atomic_red_team/ (46 MB).
  • stix2 not imported anywhere; no requirements.txt in the repo.

🤖 Generated with Claude Code

deacon-mp and others added 2 commits May 20, 2026 09:53
…cCaldera fork

The README's Installation/Dependencies steps described the third-party
xenoscr/atomiccaldera project rather than this plugin. Every step was
inaccurate for mitre/atomic:

- Cloned xenoscr/atomiccaldera (and added `atomiccaldera` to plugins) instead
  of mitre/atomic / `atomic`.
- `pip install -r requirements.txt` — no requirements file exists in this repo.
- Manual `git clone redcanaryco/atomic-red-team` — the plugin clones this
  automatically on first enable (app/atomic_svc.py:clone_atomic_red_team_repo).
- `git clone mitre/cti` + STIX2 dependency — never used; the technique/tactic
  mapping is read from enterprise-attack.json bundled inside the atomic-red-team
  repo (app/atomic_svc.py:111).
- `edit conf/artconf.yml` — no conf/ directory or artconf reference exists in
  the code.

Rewrites Installation to the standard CALDERA plugin flow (clone into plugins/,
enable in local.yml, restart; data is auto-fetched) and trims Dependencies to
what is actually required.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…tion-instructions

# Conflicts:
#	README.md
@deacon-mp deacon-mp merged commit 915ea7a into master May 20, 2026
@deacon-mp deacon-mp deleted the fix/readme-installation-instructions branch May 20, 2026 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant