This page is auto-generated. Do not edit directly.
To update, modify the CLI source in pinner-cli and run pnpm generate:cli.
A minimal, developer-focused CLI tool for pinning content to IPFS via the Pinner.xyz service.
Install
See Getting Started with the CLI to install the Pinner CLI.
Authentication
Most commands require authentication. Run pinner setup for the interactive wizard, or set PINNER_AUTH_TOKEN in your environment.
Global Flags
Flag Alias Description --jsonOutput JSON instead of human-readable --verboseShow detailed output --quietSuppress non-error output --unmaskShow sensitive data (tokens, passwords, secrets) unmasked --auth-tokenAuth token to override config --secureUse HTTPS for API connections
Environment Variables
Variable Description PINNER_AUTH_TOKENAuth token to override config PINNER_SECUREUse HTTPS for API connections PINNER_EMAILEmail address for login PINNER_PASSWORDPassword for login (WARNING: insecure, prefer stdin or env var) PINNER_OTPOTP code for 2FA (6 digits) PINNER_MEMORY_LIMITMemory limit for CAR generation in megabytes
Command Summary
Command Description setup Run the interactive setup wizard to configure your Pinner.xyz CLI environment. This wizard will guide you through authentication and configuration. auth Authenticate with the Pinner.xyz service. register Register a new user account on Pinner.xyz. confirm-email Confirm your email address using the verification token sent to your email. account Manage your Pinner.xyz account settings including 2FA configuration.
Command Description upload Upload files or directories to IPFS via the Pinner.xyz service. Content is converted to CAR format before uploading. download Download content from IPFS by CID and save it to the local filesystem. Supports CID paths (e.g., CID/path/to/file) to download a specific file from a directory. cat Stream the contents of an IPFS CID to stdout. Supports CID paths (e.g., CID/path/to/file) to cat a specific file from a directory. ls List the contents of a directory pinned on IPFS by CID. Shows file names, types, and sizes for each entry. Supports CID paths (e.g., CID/path/to/dir) to list nested directories.
Command Description pin Shortcut for 'pinner pins add'. Pin existing IPFS content by CID. Multiple CIDs can be provided as arguments, read from a file using --file, or piped from stdin. pins Manage your pinned IPFS content with subcommands for adding, removing, listing, checking status, and updating pin metadata. list Shortcut for 'pinner pins ls'. List your pinned content with optional filtering. status Shortcut for 'pinner pins status'. Check whether a pin has completed. If the pin is not found, account operations are checked as a fallback. unpin Shortcut for 'pinner pins rm'. Remove pins by CID or remove all pins. metadata The 'metadata' command has been removed. Use 'pinner pins update' to update pin metadata instead
Command Description point Point an onchain/decentralized domain at IPFS content via IPNS. unpoint Remove the IPNS key for an onchain/decentralized domain. The domain will no longer resolve to IPFS content. operations View and monitor account operations such as uploads, pins, and other processing tasks. dns Manage DNS zones and records for your domains. DNS hosting allows you to control DNS configuration for IPFS-hosted websites. ipns IPNS provides a mutable address scheme for IPFS content, allowing you to publish content under a stable name that you can update to point to new CIDs. websites Manage websites for your IPFS content. Websites allow you to associate domain names with CIDs, making your content accessible through custom domains.
Command Description config View or modify CLI configuration settings. doctor Show diagnostic information about your pinner CLI environment, including version, OS details, configuration location, and limits. bench Run a benchmark by uploading random data (or a specified path) and tracking each stage of the pipeline: generate, upload, queued, pinning, pinned. generate-docs Generate CLI documentation in markdown, man, or JSON format
Command Description admin Administrative operations for quota management, billing, and profiling.
