composter-cli 1.0.3 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +47 -0
  2. package/package.json +17 -4
package/README.md ADDED
@@ -0,0 +1,47 @@
1
+ # 🌱 Composter CLI
2
+
3
+ > Your personal vault for storing, syncing, and retrieving reusable React components from the command line.
4
+
5
+ [![npm version](https://img.shields.io/npm/v/composter-cli.svg)](https://www.npmjs.com/package/composter-cli)
6
+ [![license](https://img.shields.io/npm/l/composter-cli.svg)](https://github.com/binit2-1/Composter/blob/main/LICENSE)
7
+
8
+ **Composter** is like your personal shadcn/ui — but for YOUR components. Push components from any project, pull them into new ones, and let AI assistants access your vault via MCP.
9
+
10
+ ## ✨ Features
11
+
12
+ - **📤 Push** — Upload components with all their local dependencies auto-bundled
13
+ - **📥 Pull** — Download components into any project with dependency detection
14
+ - **📁 Categories** — Organize components into logical groups
15
+ - **🔗 Smart Bundling** — Automatically crawls and bundles relative imports
16
+ - **📦 Dependency Tracking** — Detects npm packages and alerts you to missing ones
17
+ - **🤖 MCP Ready** — Works with Claude, Cursor, and other AI assistants
18
+
19
+ ## 📦 Installation
20
+
21
+ npm install -g composter-cli## 🚀 Quick Start
22
+
23
+ # 1. Create an account at https://composter.vercel.app
24
+
25
+ # 2. Login to your vault
26
+ composter login
27
+
28
+ # 3. Create a category
29
+ composter mkcat buttons
30
+
31
+ # 4. Push a component
32
+ composter push buttons "Animated Button" ./src/components/Button.tsx
33
+
34
+ # 5. Pull it in another project
35
+ composter pull buttons "Animated Button" ./src/components/## 📖 Commands
36
+
37
+ | Command | Description |
38
+ |---------|-------------|
39
+ | `composter login` | Authenticate with your account |
40
+ | `composter mkcat <name>` | Create a new category |
41
+ | `composter ls` | List all categories |
42
+ | `composter push <category> <title> <file>` | Push a component |
43
+ | `composter pull <category> <title> <dir>` | Pull a component |
44
+
45
+ ## 🔧 Smart Bundling
46
+
47
+ When you push, the CLI automatically bundles all local imports:
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "composter-cli",
3
- "version": "1.0.3",
3
+ "version": "1.0.4",
4
4
  "type": "module",
5
- "description": "CLI tool to manage and sync React components to your personal component vault",
5
+ "description": "Your personal vault for React components. Push, pull, and sync reusable components across projects like shadcn/ui but for YOUR code.",
6
6
  "main": "src/index.js",
7
7
  "bin": {
8
8
  "composter": "./bin/composter.js"
@@ -16,13 +16,26 @@
16
16
  "cli",
17
17
  "vault",
18
18
  "library",
19
- "shadcn"
19
+ "shadcn",
20
+ "component-library",
21
+ "code-sharing",
22
+ "developer-tools",
23
+ "productivity",
24
+ "mcp",
25
+ "ai-tools"
20
26
  ],
21
27
  "author": "binit2-1",
22
28
  "license": "MIT",
23
29
  "repository": {
24
30
  "type": "git",
25
- "url": "https://github.com/binit2-1/Composter"
31
+ "url": "git+https://github.com/binit2-1/Composter.git"
32
+ },
33
+ "homepage": "https://composter.vercel.app",
34
+ "bugs": {
35
+ "url": "https://github.com/binit2-1/Composter/issues"
36
+ },
37
+ "engines": {
38
+ "node": ">=18.0.0"
26
39
  },
27
40
  "dependencies": {
28
41
  "commander": "^14.0.2",