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

CLI Global Flags

Flags available on all commands.

Available Flags

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

Examples

# JSON output
pinner list --json
 
# Verbose logging
pinner upload file.txt --verbose
 
# Suppress output
pinner upload file.txt --quiet
 
# Show unmasked tokens
pinner config --unmask
 
# Override auth token
pinner upload file.txt --auth-token "YOUR_TOKEN"
 
# Use HTTP instead of HTTPS
pinner status bafy... --secure false

Environment Variables

VariableDescription
PINNER_AUTH_TOKENAPI authentication token
PINNER_SECUREUse HTTPS (true/false, default: true)
PINNER_EMAILEmail address for authentication
PINNER_PASSWORDPassword for authentication
PINNER_OTP6-digit OTP code for 2FA
PINNER_MEMORY_LIMITMemory limit for CAR generation in MB

Output Modes

The CLI supports different output modes:

  • Default: Human-readable colored output
  • --json: Machine-readable JSON output
  • --quiet: Minimal output (errors only)
  • --verbose: Detailed output with debug information
  • --unmask: Show sensitive values (tokens, passwords)