PinMe - Zero-Config Frontend Deployment
Deploy static websites to IPFS network with a single command. No servers, no accounts, no setup.
When to Use
Use this skill when:
- User asks to "deploy", "upload", or "publish" a frontend project
- User wants to get a preview URL for their built site
- User mentions PinMe or IPFS deployment
- Project has built static files (dist/, build/, out/, public/)
Quick Start
# Install PinMe
npm install -g pinme
# Deploy (auto-detects static directory)
pinme upload dist
# Get preview URL
# https://pinme.eth.limo/#/preview/*
Core Workflow
1. Check Prerequisites
# Check Node.js version (requires 16.13.0+)
node --version
# Verify pinme is installed
pinme --version
2. Identify Static Directory
PinMe auto-detects directories in priority order:
| Directory |
Framework/Tool |
dist/ |
Vite, Vue CLI, Angular |
build/ |
Create React App |
out/ |
Next.js (static export) |
public/ |
Static sites |
Validation rules:
- ✅ Folder must exist
- ✅ Must contain
index.html
- ✅ Must have actual static files (CSS, JS, images)
3. Execute Deployment
# Deploy dist directory (most common)
pinme upload dist
# Deploy specific directory
pinme upload build
# Upload and bind to custom domain (requires Plus)
pinme upload dist --domain my-site
4. Return Result
Return ONLY the preview URL: https://pinme.eth.limo/#/preview/*
Commands Reference
| Command |
Description |
pinme upload <dir> |
Upload static files to IPFS |
pinme upload <dir> --domain <name> |
Upload + bind domain |
pinme import <car-file> |
Import CAR files |
pinme export <CID> |
Export IPFS content as CAR |
pinme list |
Show upload history |
pinme rm <hash> |
Remove files from IPFS |
pinme set-appkey |
Set AppKey for authentication |
pinme my-domains |
List owned domains |
pinme --version |
Show version |
Upload Limits
| Type |
Free Plan |
| Single file |
200MB |
| Total directory |
1GB |
Error Handling
| Error |
Solution |
| Node.js version too low |
Upgrade to 16.13.0+ |
| Command not found |
Run npm install -g pinme |
| Folder does not exist |
Check path, use ls |
| Upload failed |
Check network, retry |
| Authentication failed |
Run pinme set-appkey |
AI Execution Protocol
For programmatic deployment:
- Check environment:
node --version (needs >=16.13.0)
- Install if needed:
npm install -g pinme
- Detect directory: Check
dist/, build/, out/, public/
- Validate: Must contain
index.html
- Execute:
pinme upload <directory>
- Return: Only the preview URL
Prohibited operations:
- ❌ Upload node_modules, .env, .git
- ❌ Upload source directories (src/)
- ❌ Upload config files (package.json, etc.)
- ❌ Upload non-existent/empty folders
GitHub Actions Integration
Example workflow:
name: Deploy to PinMe
on: [push]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: '18'
- run: npm ci && npm run build
- run: npm install -g pinme
- run: pinme set-appkey "${{ secrets.PINME_APPKEY }}"
- run: pinme upload dist --domain "${{ secrets.DOMAIN }}"
Machine-Readable Config
{
"tool": "pinme",
"requirements": {
"node_version": ">=16.13.0"
},
"install": "npm install -g pinme",
"upload": "pinme upload {{directory}}",
"upload_with_domain": "pinme upload {{directory}} --domain {{domain}}",
"validDirectories": ["dist", "build", "out", "public"],
"requiredFiles": ["index.html"],
"excludePatterns": ["node_modules", ".env", ".git", "src"],
"limits": {
"single_file": "200MB",
"total_directory": "1GB"
},
"output": "preview_url",
"preview_url_format": "https://pinme.eth.limo/#/preview/*",
"fixed_domain_format": "https://*.pinit.eth.limo"
}
Resources
1---2name: pinme3description: Deploy static websites to IPFS with a single command using PinMe CLI. Use when: (1) User wants to deploy a built frontend project, (2) Need to upload static files (dist/build/out/public) to IPFS, (3) Requesting preview URL for a deployed site. Supports: Vite, React, Vue, Next.js, Angular, Create React App, and static sites. Output: Preview URL (https://pinme.eth.limo/#/preview/*) after successful upload.4---56# PinMe - Zero-Config Frontend Deployment78Deploy static websites to IPFS network with a single command. No servers, no accounts, no setup.910## When to Use1112Use this skill when:13- User asks to "deploy", "upload", or "publish" a frontend project14- User wants to get a preview URL for their built site15- User mentions PinMe or IPFS deployment16- Project has built static files (dist/, build/, out/, public/)1718## Quick Start1920```bash21# Install PinMe22npm install -g pinme2324# Deploy (auto-detects static directory)25pinme upload dist2627# Get preview URL28# https://pinme.eth.limo/#/preview/*29```3031## Core Workflow3233### 1. Check Prerequisites34```bash35# Check Node.js version (requires 16.13.0+)36node --version3738# Verify pinme is installed39pinme --version40```4142### 2. Identify Static Directory43PinMe auto-detects directories in priority order:4445| Directory | Framework/Tool |46|-----------|---------------|47| `dist/` | Vite, Vue CLI, Angular |48| `build/` | Create React App |49| `out/` | Next.js (static export) |50| `public/` | Static sites |5152**Validation rules:**53- ✅ Folder must exist54- ✅ Must contain `index.html`55- ✅ Must have actual static files (CSS, JS, images)5657### 3. Execute Deployment58```bash59# Deploy dist directory (most common)60pinme upload dist6162# Deploy specific directory63pinme upload build6465# Upload and bind to custom domain (requires Plus)66pinme upload dist --domain my-site67```6869### 4. Return Result70Return ONLY the preview URL: `https://pinme.eth.limo/#/preview/*`7172## Commands Reference7374| Command | Description |75|---------|-------------|76| `pinme upload <dir>` | Upload static files to IPFS |77| `pinme upload <dir> --domain <name>` | Upload + bind domain |78| `pinme import <car-file>` | Import CAR files |79| `pinme export <CID>` | Export IPFS content as CAR |80| `pinme list` | Show upload history |81| `pinme rm <hash>` | Remove files from IPFS |82| `pinme set-appkey` | Set AppKey for authentication |83| `pinme my-domains` | List owned domains |84| `pinme --version` | Show version |8586## Upload Limits8788| Type | Free Plan |89|------|----------|90| Single file | 200MB |91| Total directory | 1GB |9293## Error Handling9495| Error | Solution |96|-------|----------|97| Node.js version too low | Upgrade to 16.13.0+ |98| Command not found | Run `npm install -g pinme` |99| Folder does not exist | Check path, use `ls` |100| Upload failed | Check network, retry |101| Authentication failed | Run `pinme set-appkey` |102103## AI Execution Protocol104105For programmatic deployment:1061071. **Check environment**: `node --version` (needs >=16.13.0)1082. **Install if needed**: `npm install -g pinme`1093. **Detect directory**: Check `dist/`, `build/`, `out/`, `public/`1104. **Validate**: Must contain `index.html`1115. **Execute**: `pinme upload <directory>`1126. **Return**: Only the preview URL113114**Prohibited operations:**115- ❌ Upload node_modules, .env, .git116- ❌ Upload source directories (src/)117- ❌ Upload config files (package.json, etc.)118- ❌ Upload non-existent/empty folders119120## GitHub Actions Integration121122Example workflow:123124```yaml125name: Deploy to PinMe126on: [push]127jobs:128 deploy:129 runs-on: ubuntu-latest130 steps:131 - uses: actions/checkout@v4132 - uses: actions/setup-node@v4133 with:134 node-version: '18'135 - run: npm ci && npm run build136 - run: npm install -g pinme137 - run: pinme set-appkey "${{ secrets.PINME_APPKEY }}"138 - run: pinme upload dist --domain "${{ secrets.DOMAIN }}"139```140141## Machine-Readable Config142143```json144{145 "tool": "pinme",146 "requirements": {147 "node_version": ">=16.13.0"148 },149 "install": "npm install -g pinme",150 "upload": "pinme upload {{directory}}",151 "upload_with_domain": "pinme upload {{directory}} --domain {{domain}}",152 "validDirectories": ["dist", "build", "out", "public"],153 "requiredFiles": ["index.html"],154 "excludePatterns": ["node_modules", ".env", ".git", "src"],155 "limits": {156 "single_file": "200MB",157 "total_directory": "1GB"158 },159 "output": "preview_url",160 "preview_url_format": "https://pinme.eth.limo/#/preview/*",161 "fixed_domain_format": "https://*.pinit.eth.limo"162}163```164165## Resources166167- **Website:** https://pinme.eth.limo/168- **GitHub:** https://github.com/glitternetwork/pinme169- **AppKey:** https://pinme.eth.limo/ (get from dashboard)
dvcrn