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 Getting Started

Install and configure the Pinner CLI.

Prerequisites

Installation

go install

go install go.lumeweb.com/pinner-cli/cmd/pinner@latest

Download Binary

Download the latest binary from the releases page.

Initial Setup

The CLI includes an interactive setup wizard that guides you through authentication and configuration:

# Run the setup wizard
pinner setup
 
# Skip specific steps if needed
pinner setup --skip-auth
pinner setup --skip-config
pinner setup --reset

Authentication

Authentication Commands

Login

# Interactive login (prompts for all inputs)
pinner auth
 
# Provide email, prompt for password and OTP if needed
pinner auth --email user@example.com
 
# Non-interactive with environment variables
PINNER_EMAIL=user@example.com PINNER_PASSWORD=yourpassword pinner auth
 
# With 2FA code
PINNER_EMAIL=user@example.com PINNER_PASSWORD=yourpassword PINNER_OTP=123456 pinner auth
 
# Provide API token directly
pinner auth YOUR_API_TOKEN
 
# Create a named API key
pinner auth --email user@example.com --key-name "my-laptop"

Register

# Interactive mode (prompts for all required fields)
pinner register
 
# Non-interactive with flags
pinner register --email user@example.com --first-name John --last-name Doe

Confirm Email

pinner confirm --email user@example.com --tokenabc123def456

Verification

# Check version
pinner --version
 
# View help
pinner --help
 
# Run diagnostics
pinner doctor