PinMe is a simple and easy-to-use command-line tool for uploading files and directories to the IPFS network.
Website๏ผhttps://pinme.eth.limo/
- ๐ Quickly upload files and directories to IPFS
- ๐ Support for various file types and sizes
- ๐ View and manage upload history
- ๐ Automatically generate accessible IPFS links
- ๐ Preview uploaded content
npm install -g pinme
yarn global add pinme
# Interactive upload
pinme upload
# Specify path directly
pinme upload /path/to/file-or-directory
# Interactive removal
pinme rm
# Remove a specific file by hash
pinme rm <IPFS_hash>
# Show the last 10 upload records
pinme list
# Or use the shorthand command
pinme ls
# Limit the number of records shown
pinme list -l 5
# Clear all upload history
pinme list -c
# Display help information
pinme help
Upload a file or directory to the IPFS network.
pinme upload [path]
Options:
path
: Path to the file or directory to upload (optional, if not provided, interactive mode will be entered)
Examples:
# Interactive upload
pinme upload
# Upload a specific file
pinme upload ./example.jpg
# Upload an entire directory
pinme upload ./my-website
Remove a file from the IPFS network.
pinme rm [hash]
Options:
hash
: IPFS content hash to remove (optional, if not provided, interactive mode will be entered)
Examples:
# Interactive removal
pinme rm
# Remove a specific file by hash
pinme rm bafybeifdwyoz66u5czbbjvmmais5fzrzrolxbyiydqsbrxessndt3s6zdi
Note: This action permanently removes content from the IPFS network. Make sure you have the correct IPFS hash before proceeding.
Display upload history.
pinme list [options]
pinme ls [options]
Options:
-l, --limit <number>
: Limit the number of records displayed-c, --clear
: Clear all upload history
Examples:
# Show the last 10 records
pinme list
# Show the last 5 records
pinme ls -l 5
# Clear all history records
pinme list -c
Display help information.
pinme help [command]
Options:
command
: The specific command to view help for (optional)
Examples:
# Display general help
pinme help
- Single file size limit: 20MB
- Total directory size limit: 500MB
Uploaded files are stored on the IPFS network and accessible through the Glitter Protocol's IPFS gateway. After a successful upload, you will receive:
- IPFS content hash
- Accessible URL link
Logs and configuration files are stored in:
- Linux/macOS:
~/.pinme/
- Windows:
%USERPROFILE%\.pinme\
MIT License - See the LICENSE file for details
When uploading projects built with Vite, please note:
- Vite Configuration: Add
base: "./"
to your Vite configuration file to ensure proper asset path resolution:
// vite.config.js
export default {
base: "./",
// other configurations...
}
If you have questions or suggestions, please contact us through:
- GitHub Issues: https://github.com/glitternetwork/pinme/issues
- Email: pinme@glitterprotocol.io
Developed and maintained by the Glitter Protocol team