Skip to content

Waqas-Khan-CodeCanvas/Composter

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Composter Logo

Composter

Your Personal Vault for React Components

Upload, organize, and retrieve your components instantly with CLI, Dashboard, and MCP integration.

MIT License npm version CI Status Issues GitHub stars


Composter Landing Page

✨ Features

  • πŸ—ƒοΈ Component Vault β€” Store and organize your React components in categories
  • ⚑ CLI Tool β€” Push, pull, and manage components directly from your terminal
  • 🎨 Web Dashboard β€” Visual interface to browse, preview, and manage your library
  • πŸ”Œ MCP Compatible β€” Works with Claude, Cursor, GitHub Copilot, and other AI assistants
  • πŸ” Secure Auth β€” Better Auth integration with JWT-based authentication
  • πŸ“¦ Live Preview β€” Sandpack-powered component previews with Tailwind CSS support
  • πŸ“‹ One-Click Copy β€” Copy component code or CLI commands instantly

πŸ”— Links

πŸš€ Quick Start

For Users (No Setup Required)

  1. Install the CLI:

    npm install -g composter-cli
  2. Login and start using:

    composter login
    composter mkcat my-category
    composter push my-category "MyComponent" ./component.jsx
  3. Access the web dashboard:

For Contributors

Want to contribute or run locally? See CONTRIBUTING.md for full setup instructions.

πŸ“– Usage

CLI Commands

# Login to your account
composter login

# Create a category
composter mkcat buttons

# List all categories
composter ls

# Push a component
composter push buttons "PrimaryButton" ./src/components/Button.jsx

# Pull a component
composter pull buttons "PrimaryButton" ./components/

CLI Usage

Web Dashboard

Access the dashboard at composter.vercel.app

Dashboard

Dashboard Features

  • Browse Components β€” View all saved components organized by category
  • Live Preview β€” See components rendered in real-time
  • Code View β€” Inspect source code with syntax highlighting
  • Copy Commands β€” One-click copy for npm install and CLI commands

Component Detail

πŸ€– MCP Integration

Composter includes a Model Context Protocol (MCP) server that enables AI assistants to interact with your component vault.

Supported AI Tools

Tool Status
Claude Desktop βœ… Supported
Cursor βœ… Supported
GitHub Copilot βœ… Supported
VS Code + MCP Extensions βœ… Supported
Windsurf βœ… Supported

Setup

  1. Login via CLI first:

    composter login
  2. Auto-Configure (Recommended):

    # For Claude Desktop
    npx composter-mcp init claude
    
    # For Cursor
    npx composter-mcp init cursor
    
    # For VS Code (Copilot)
    npx composter-mcp init vscode
    
    # For Windsurf
    npx composter-mcp init windsurf
  3. Restart your AI assistant

Manual Configuration

If you prefer manual setup, add to your IDE's MCP config file:

{
  "mcpServers": {
    "composter": {
      "command": "npx",
      "args": ["composter-mcp"]
    }
  }
}

Config file locations:

  • Claude Desktop (macOS): ~/Library/Application Support/Claude/claude_desktop_config.json
  • Claude Desktop (Linux): ~/.config/claude/claude_desktop_config.json
  • Claude Desktop (Windows): %APPDATA%\Claude\claude_desktop_config.json
  • Cursor: .cursor/mcp.json (in project root)
  • VS Code: .vscode/mcp.json (in project root)
  • Windsurf: ~/.codeium/windsurf/mcp_config.json

MCP Tools

Tool Description
search_components Search components by name or category
list_categories List all categories in your vault
list_components List all components in a category
read_component Read the full source code of a component

For detailed MCP documentation, see mcp/README.md.

🀝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for detailed setup instructions, development guidelines, and how to submit pull requests.

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ™ Acknowledgments

🌟 Community

Contributors

Thanks to all our contributors! πŸŽ‰


About

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 82.6%
  • TypeScript 15.9%
  • Other 1.5%