Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Command Overview

The Pinner CLI provides commands for all operations.

Command Structure

pinner [global options] <command> [command options] [arguments...]

Global Flags

FlagDescription
--jsonOutput in JSON format
--verbose, -vEnable verbose logging
--quiet, -qSuppress non-error output
--unmaskShow sensitive data unmasked
--auth-tokenAuth token (env: PINNER_AUTH_TOKEN)
--secureUse HTTPS for API connections (default: true, env: PINNER_SECURE)

Available Commands

CommandDescription
setupInteractive first-time setup wizard
authAuthenticate with Pinner.xyz
registerCreate a new account
confirm-emailConfirm your email address
accountManage account settings (2FA)
uploadUpload files/directories to IPFS
pinPin existing content by CID
listList pinned content
statusGet pin status for CID
unpinRemove a pin
metadataUpdate pin metadata
configView/set configuration
doctorDisplay diagnostic information

Getting Help

# General help
pinner --help
 
# Command-specific help
pinner upload --help
 
# Subcommand help
pinner account otp --help

Tutorial Commands

The CLI includes a tutorial mode that shows common workflows:

# Show tutorial
pinner --help
 
# Tutorial shows commands in priority order:
# 1. pinner upload myfile.txt
# 2. pinner pin <cid>
# 3. pinner list
# 4. pinner status <cid>
# 5. pinner unpin <cid>
# 6. pinner doctor