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: |4 Deploy static websites to IPFS with a single command using PinMe CLI.5 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.6 Supports: Vite, React, Vue, Next.js, Angular, Create React App, and static sites.7 Output: Preview URL (https://pinme.eth.limo/#/preview/*) after successful upload.8---910# PinMe - Zero-Config Frontend Deployment1112Deploy static websites to IPFS network with a single command. No servers, no accounts, no setup.1314## When to Use1516Use this skill when:17- User asks to "deploy", "upload", or "publish" a frontend project18- User wants to get a preview URL for their built site19- User mentions PinMe or IPFS deployment20- Project has built static files (dist/, build/, out/, public/)2122## Quick Start2324```bash25# Install PinMe26npm install -g pinme2728# Deploy (auto-detects static directory)29pinme upload dist3031# Get preview URL32# https://pinme.eth.limo/#/preview/*33```3435## Core Workflow3637### 1. Check Prerequisites38```bash39# Check Node.js version (requires 16.13.0+)40node --version4142# Verify pinme is installed43pinme --version44```4546### 2. Identify Static Directory47PinMe auto-detects directories in priority order:4849| Directory | Framework/Tool |50|-----------|---------------|51| `dist/` | Vite, Vue CLI, Angular |52| `build/` | Create React App |53| `out/` | Next.js (static export) |54| `public/` | Static sites |5556**Validation rules:**57- ✅ Folder must exist58- ✅ Must contain `index.html`59- ✅ Must have actual static files (CSS, JS, images)6061### 3. Execute Deployment62```bash63# Deploy dist directory (most common)64pinme upload dist6566# Deploy specific directory67pinme upload build6869# Upload and bind to custom domain (requires Plus)70pinme upload dist --domain my-site71```7273### 4. Return Result74Return ONLY the preview URL: `https://pinme.eth.limo/#/preview/*`7576## Commands Reference7778| Command | Description |79|---------|-------------|80| `pinme upload <dir>` | Upload static files to IPFS |81| `pinme upload <dir> --domain <name>` | Upload + bind domain |82| `pinme import <car-file>` | Import CAR files |83| `pinme export <CID>` | Export IPFS content as CAR |84| `pinme list` | Show upload history |85| `pinme rm <hash>` | Remove files from IPFS |86| `pinme set-appkey` | Set AppKey for authentication |87| `pinme my-domains` | List owned domains |88| `pinme --version` | Show version |8990## Upload Limits9192| Type | Free Plan |93|------|----------|94| Single file | 200MB |95| Total directory | 1GB |9697## Error Handling9899| Error | Solution |100|-------|----------|101| Node.js version too low | Upgrade to 16.13.0+ |102| Command not found | Run `npm install -g pinme` |103| Folder does not exist | Check path, use `ls` |104| Upload failed | Check network, retry |105| Authentication failed | Run `pinme set-appkey` |106107## AI Execution Protocol108109For programmatic deployment:1101111. **Check environment**: `node --version` (needs >=16.13.0)1122. **Install if needed**: `npm install -g pinme`1133. **Detect directory**: Check `dist/`, `build/`, `out/`, `public/`1144. **Validate**: Must contain `index.html`1155. **Execute**: `pinme upload <directory>`1166. **Return**: Only the preview URL117118**Prohibited operations:**119- ❌ Upload node_modules, .env, .git120- ❌ Upload source directories (src/)121- ❌ Upload config files (package.json, etc.)122- ❌ Upload non-existent/empty folders123124## GitHub Actions Integration125126Example workflow:127128```yaml129name: Deploy to PinMe130on: [push]131jobs:132 deploy:133 runs-on: ubuntu-latest134 steps:135 - uses: actions/checkout@v4136 - uses: actions/setup-node@v4137 with:138 node-version: '18'139 - run: npm ci && npm run build140 - run: npm install -g pinme141 - run: pinme set-appkey "${{ secrets.PINME_APPKEY }}"142 - run: pinme upload dist --domain "${{ secrets.DOMAIN }}"143```144145## Machine-Readable Config146147```json148{149 "tool": "pinme",150 "requirements": {151 "node_version": ">=16.13.0"152 },153 "install": "npm install -g pinme",154 "upload": "pinme upload {{directory}}",155 "upload_with_domain": "pinme upload {{directory}} --domain {{domain}}",156 "validDirectories": ["dist", "build", "out", "public"],157 "requiredFiles": ["index.html"],158 "excludePatterns": ["node_modules", ".env", ".git", "src"],159 "limits": {160 "single_file": "200MB",161 "total_directory": "1GB"162 },163 "output": "preview_url",164 "preview_url_format": "https://pinme.eth.limo/#/preview/*",165 "fixed_domain_format": "https://*.pinit.eth.limo"166}167```168169## Resources170171- **Website:** https://pinme.eth.limo/172- **GitHub:** https://github.com/glitternetwork/pinme173- **AppKey:** https://pinme.eth.limo/ (get from dashboard)
Demerzels-lab