Getting Started
Compile your TypeScript codebase into deterministic architectural contracts for AI workflows.
Prerequisites
Node.js >= 20
Latest LTS recommended
TypeScript
Your project codebase
Terminal
Basic CLI knowledge
Try it now (no install required):
npx -y logicstamp-context@latest contextScans .ts / .tsx only, writes per-folder context.json and root context_main.json.
Why -y with npx?
-y tells npx not to wait on interactive install or confirmation prompts. That matters in CI, scripts, or any environment without a proper TTY, where a prompt can hang. If the package is already cached or installed globally, npx may run without -y, but keeping -y in copy-paste commands and MCP config is recommended. Same idea for the MCP server: MCP configuration.
What happened?
LogicStamp compiled your TypeScript files into structured context bundles:
- •
context.jsonfiles in each folder with component contracts - •
context_main.jsonin your project root with an overview
These files describe your components' props, hooks, dependencies, and relationships—optimized for AI consumption.
Next Steps
1. Install for regular use
Install globally to use the stamp command:
npm install -g logicstamp-contextInitialize your project (recommended):
stamp initAdds .gitignore entries for context.json, context_*.json, context.toon, *.uif.json, .logicstamp/, and stamp_security_report.json; runs a security scan; writes LLM_CONTEXT.md and .logicstamp/config.json. You can skip init and run stamp context with safe defaults.
Then compile context:
stamp contextWith Style extracts Tailwind CSS classes, SCSS modules, Material UI themes, styled-components, and framer-motion animations.
2. Use with AI assistants (MCP)
Install the MCP server to give Claude Desktop, Claude Code, or Cursor direct access to your codebase:
npm install -g logicstamp-mcp3. Keep context fresh (Watch Mode)
Automatically regenerate context as you code:
stamp context --watchStrict Watch detects breaking changes (removed props/events) and tracks violations during refactors. Learn more about watch mode →
Next Steps
Explore the complete CLI documentation or learn more about what LogicStamp does.