Skip to content

Quick start

Scaffolding any new module or service goes through thundercats, the platform CLI (package @nike/whisker-cli).

Terminal window
pnpm install -g @nike/whisker-cli
# or
npm install -g @nike/whisker-cli

The thundercats binary lands on your PATH.

Terminal window
# 1. Confirm install + see the surface area
thundercats --version
thundercats --help
# 2. Install the global @thundercats Cursor skill (once per machine, not per repo)
thundercats install-skill
# 3. Scaffold a new federation module and let thundercats populate .cursor/
thundercats create module my-first-module

Interactive prompts collect name, team, and compliance tags. When scaffolding completes, thundercats init runs automatically and writes a .cursor/ tree (plus AGENTS.md) so AI coding agents in the new repo already understand the platform’s conventions — the @thundercats skill itself already works there since it’s installed globally, not per repo.

Always pass --non-interactive and -y together, never just one:

Terminal window
thundercats create module my-module --non-interactive -y \
--name my-module \
--description "..." \
--manager-email you@nike.com \
--team APEX \
--nike-department ... \
--nike-distributionlist ... \
--nike-domain ...

Run thundercats create module --fields to print the full required-input catalog before scaffolding.

If you have an existing app you want to embed rather than rewrite, see Federation vs. iframe — you likely want thundercats add iframe-consumer instead of create module.