Usage & Configuration

Output formats, pagination, environment variables, and advanced configuration.

Output Formats

Table (Default)

Human-readable table with colors. Colors are automatically disabled when output is piped.

porteden calendar events --today

JSON

Structured data for scripting and integrations:

porteden calendar events --today -j

Plain Text (TSV)

Tab-separated values for shell processing:

porteden calendar events --today -p

Compact Mode

Reduces output size by filtering noise, truncating long fields, and limiting attendee lists. Ideal for AI agents and automation:

porteden calendar events --today -c 
 
# JSON + compact (recommended for AI agents)
porteden calendar events --today -jc

Color Control

porteden calendar events --today --color never    # Disable 
porteden calendar events --today --color always   # Force 
porteden calendar events --today --color auto     # Default

Pagination

By default, commands return up to 50 results. To get more:

# Auto-fetch all pages
porteden calendar events --week --all 
 
# Manual pagination
porteden calendar events --week --limit 100 --offset 0 
porteden calendar events --week --limit 100 --offset 100

Environment Variables

Variable	Description
`PE_API_KEY`	API key (overrides stored credentials)
`PE_PROFILE`	Default profile name
`PE_TIMEZONE`	Output timezone (e.g., America/New_York)
`PE_FORMAT`	Default output format: json, table, plain
`PE_VERBOSE`	Enable verbose output: 1 or true
`PE_COLOR`	Color mode: auto, always, never
`NO_COLOR`	Disable colors (standard)

Debugging

Verbose mode shows HTTP request/response details with authorization headers redacted:

porteden -v calendar events --today

Shell Completions

# Bash
porteden completion bash > /etc/bash_completion.d/porteden 
 
# Zsh
porteden completion zsh > "${fpath[1]}/_porteden" 
 
# Fish
porteden completion fish > ~/.config/fish/completions/porteden.fish 
 
# PowerShell
porteden completion powershell > porteden.ps1

Reload your shell

After installing completions, restart your shell or source the completion file for changes to take effect.