Quick Start Guide

Installation & Quick Start

Install LogicStamp Context CLI and generate AI-ready context for your React/TypeScript projects in under 2 minutes

Zero configuration

up to 65% token reduction

AI-optimized output

Prerequisites

🟢

Node.js 18+

Latest LTS recommended

⚛️

React/TypeScript

Your project codebase

💻

Terminal

Basic CLI knowledge

Install LogicStamp Context

Install the CLI globally to use the stamp command from anywhere on your system.

💡 Pro tip: Global installation provides system-wide access to the CLI, perfect for working across multiple projects.

npm install -g logicstamp-context

Initialize Your ProjectOptional

Set up .gitignore patterns and generate initial documentation. The CLI will prompt you on first run if you skip this step.

What it does:

• Adds context files to .gitignore
• Creates LLM_CONTEXT.md guide
• Sets up project structure

When to skip:

• Testing the tool first
• Temporary analysis
• CI/CD environments

cd your-react-project
stamp init

Generate AI Context

Run the context generator to analyze your codebase and create structured bundles optimized for AI assistants.

Output Structure

context_main.jsonproject index

src/app/docs/getting-started/context.json

src/components/context.json

src/hooks/context.json

stamp context

Integrate with AI Assistants

Your generated context.json bundles and context_main.json index plug straight into your favorite AI coding tools.

Cursor

Uses context.json bundles automatically when you run AI commands.

Detects context.json when you trigger AI
No extra configuration
Keeps suggestions aligned with your project

Windsurf

Understands your context.json bundles alongside the workspace.

Picks up context.json in open projects
Boosts inline completions with component context
Works seamlessly with existing AI workflows

GitHub Copilot

Guide Copilot by opening or referencing context.json files.

Chat integration via Copilot Chat
File reference support (@file context.json)
More relevant, context-aware suggestions

Claude

Paste or upload context.json bundles for deep analysis.

Manual file upload or copy-paste
Detailed reasoning over your contracts
Stronger understanding of component behavior

ChatGPT

Upload or paste context.json to drive the conversation.

File upload support (Code / Advanced Data)
Multi-file context via zipped bundles or multiple uploads
Conversation history that stays aligned with your code

Other IDEs

Use context.json with any editor that has an AI sidebar or chat.

Manual integration via file open / copy-paste
Works with any file system / repo
Universal, assistant-agnostic format

💡 Best Practice: When prompting an AI assistant, explicitly tell it to use the per-folder context.json files and the root context_main.json to understand your project structure. This produces the most consistent and grounded results across all assistants.

Using context.json files, explain the authentication flow

Optimize Token UsageAdvanced

Compare different code inclusion modes to find the perfect balance between context richness and token efficiency.

Mode	Savings	Content	Use Case
`none`	~79%	Contracts only	API docs
`header`default	~65%	JSDoc + contracts	AI chat
`full`	0%	Complete source	Deep analysis

stamp context --compare-modes

Validate OutputCI/CD Ready

Ensure your context files are valid and schema-compliant before sharing or committing.

Validation includes:

• JSON structure integrity
• Required field verification
• Schema compliance check
• Exit code: 0 (success) or 1 (failure)

stamp context validate

🎉 Congratulations! You're All Set

You've successfully installed LogicStamp Context and generated AI-ready documentation for your React/TypeScript project. Your context files are now ready to supercharge your AI-assisted development workflow.

65%

Average token reduction

Faster AI comprehension

100%