PinMe is a zero-config frontend deployment tool designed for single-command deployment of static sites, AI-generated pages, or exported frontends. It addresses the need for fast, secure, and hassle-free hosting by publishing sites as verifiable content on IPFS, enhancing tamper resistance and simplifying management. The tool is targeted at developers and power users who want to deploy quickly without managing servers, accounts, or complex setup procedures, benefiting from built-in availability and persistence.

How It Works

PinMe utilizes IPFS for decentralized storage and the Glitter Protocol's gateway for access. After installation, users build their frontend project and then execute the pinme upload <directory> command. The CLI automatically detects common build output directories such as dist/, build/, out/, and public/, provided they contain an index.html file and other static assets. This approach ensures content immutability and provides a verifiable deployment, making it significantly harder to tamper with or accidentally break hosted websites compared to traditional hosting methods.

Quick Start & Requirements

• Primary install / run command: npm install -g pinme or yarn global add pinme.
• Non-default prerequisites and dependencies: Node.js 16.13.0 or higher.
• Estimated setup time or resource footprint: Minimal; installation is quick, and deployment involves a single command after a potential build step.
• Links: Website: https://pinme.eth.limo/, GitHub Issues: https://github.com/glitternetwork/pinme/issues.

Highlighted Details

• Zero-configuration, single-command deployment for frontend projects.
• Deploys content to IPFS, offering verifiable and tamper-resistant hosting.
• Supports AI assistants with a defined execution protocol for deployment tasks.
• Integrates with GitHub Actions for automated CI/CD pipelines.
• Automatically detects and prioritizes common static build output directories.

Maintenance & Community

Developed and maintained by the Glitter Protocol team. Contact is available via GitHub Issues (https://github.com/glitternetwork/pinme/issues) or email (pinme@glitterprotocol.io). No specific community channels like Discord or Slack are listed in the README.

Licensing & Compatibility

The project is released under the MIT License. This license is permissive and generally allows for commercial use and linking within closed-source projects.

Limitations & Caveats

The free tier imposes upload limits: 200MB for a single file and 1GB for a total directory. Binding uploads to fixed domains (e.g., *.pinit.eth.limo) requires a "Plus membership" and an AppKey. While pinme rm can unpin content from the project's IPFS node and remove ENS subdomain records, it does not guarantee removal from the entire IPFS network. Node.js version 16.13.0 or higher is strictly required.