memberstack-ai-docs
v1.3.0
Published
AI-friendly documentation installer for Memberstack DOM package
Downloads
36
Maintainers
Readme
Memberstack AI Documentation
AI-optimized documentation installer for the Memberstack DOM package. Makes Memberstack's complete API instantly accessible to AI coding assistants like Claude Code, Cursor, GitHub Copilot, and others.
🚀 Quick Start
Install the Memberstack AI documentation in your project:
npx memberstack-ai-docsThe installer will ask which AI assistant you're using:
- Claude Code - Creates
CLAUDE.md - Cursor - Creates
.cursorrules - Codex - Creates
AGENTS.md - All - Creates all three
Or specify directly:
npx memberstack-ai-docs --ai claude # Claude Code only
npx memberstack-ai-docs --ai cursor # Cursor only
npx memberstack-ai-docs --ai codex # Codex (AGENTS.md)
npx memberstack-ai-docs --ai all # All supported tools📦 What Gets Installed
The installer creates:
.memberstack/directory containing:complete.md- Full documentation for all 49 methodsindex.json- Searchable method index for AI discoveryquickref.md- Quick reference with 30 most common methods
AI config files (based on your selection):
CLAUDE.md- For Claude Code (if selected).cursorrules- For Cursor (if selected)AGENTS.md- For Codex (if selected)
The installer is non-destructive - it preserves your existing content and only adds clearly marked Memberstack sections.
🎯 Features
- Complete API Coverage: All 57 Memberstack methods documented with signatures, parameters, and examples
- AI-Optimized: Structured for efficient parsing and searching by AI agents
- Smart Search: JSON index enables AI to quickly find relevant methods
- Progressive Discovery: Quick reference → Index search → Full documentation
- Safe Installation: Never overwrites existing content, only appends marked sections
- Easy Updates: Keep documentation current with
--updateflag - Clean Removal: Uninstall cleanly with
--removeflag
📋 Commands
# Install documentation
npx memberstack-ai-docs
# Update to latest version
npx memberstack-ai-docs --update
# Remove documentation
npx memberstack-ai-docs --remove
# Validate installation
npx memberstack-ai-docs --validate
# Preview changes without modifying files
npx memberstack-ai-docs --dry-run
# Show detailed output
npx memberstack-ai-docs --verbose🤖 How AI Assistants Use This
Once installed, AI assistants can:
- Immediate Access: View most common methods directly in CLAUDE.md/.cursorrules
- Search Methods: Query the JSON index to find specific functionality
- Deep Dive: Access complete documentation for detailed implementation
Example AI queries that now work:
- "How do I implement passwordless login with Memberstack?"
- "Show me all Memberstack methods for managing subscriptions"
- "Create a React component with Memberstack authentication"
📚 Documentation Structure
Method Categories
- Initialization (2 methods): SDK setup and connection testing
- Authentication (11 methods): Login, signup, logout, passwordless, social auth, verification
- Member Management (7 methods): Profile updates, custom fields, metadata, JSON data
- Billing (6 methods): Plans, subscriptions, Stripe checkout, billing portal
- UI Components (6 methods): Pre-built modals, loaders, messages
- Content (9 methods): Secure content, posts, comments, threads, voting
- Teams (4 methods): Team management, invitations
- Data Tables (8 methods): Database operations, query records, manage tables, reference fields
- Internal (1 method): Event tracking
Method Example
Every method is documented with:
- Complete signature with TypeScript types
- All parameters (required and optional)
- Return type
- Multiple code examples
- Error handling patterns
- Common use cases
🔧 For Developers
Manual Installation
If you prefer to set up manually:
- Download the documentation files from GitHub
- Create
.memberstack/directory in your project - Copy documentation files to
.memberstack/ - Add Memberstack section to your CLAUDE.md/.cursorrules/AGENTS.md
Building From Source
# Clone repository
git clone https://github.com/julianmemberstack/memberstack-ai-docs
cd memberstack-ai-docs
# Install dependencies
npm install
# Build index from documentation
npm run build-index
# Test locally
npm testPublishing Updates
# Update version
npm version patch
# Publish to NPM
npm publish🛟 Support
- Issues: GitHub Issues
- Documentation: Memberstack Docs
- Community: Memberstack Slack
📄 License
MIT License - See LICENSE file for details
🙏 Credits
Created by Julian Galluzzo for Memberstack
Making AI coding assistants smarter about Memberstack, one method at a time.
