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 Config

Manage CLI configuration.

config command

pinner config [get <key> | set <key> <value>]

View All Configuration

pinner config

Displays all configuration values with descriptions.

Get Configuration Value

# Get specific value
pinner config get base_endpoint
 
# Get secure setting
pinner config get secure

Set Configuration Value

# Set base endpoint
pinner config set base_endpoint "api.pinner.xyz"
 
# Disable HTTPS
pinner config set secure false
 
# Set max retries
pinner config set max_retries 5
 
# Set memory limit for CAR generation in MB
pinner config set memory_limit 256
 
# Preview without saving
pinner config set memory_limit 256 --dry-run

Common Configuration Keys

KeyTypeDescription
base_endpointstringAPI endpoint domain (empty for default)
secureboolUse HTTPS (default: true)
max_retriesintMaximum retry attempts (default: 3)
memory_limitintMemory limit for CAR generation in MB (default: 100)

Configuration File

The CLI stores configuration in ~/.config/pinner/config.json:

{
  "base_endpoint": "",
  "secure": true,
  "max_retries": 3,
  "memory_limit": 100
}

Note: The authentication token is managed separately by the pinner auth command.

Options

OptionDescription
--dry-runPreview changes without saving

Subcommands

SubcommandDescription
(none)Show all configuration values
get <key>Get specific configuration value
set <key> <value>Set configuration value