Struktur

Installation & Setup

Install and configure Struktur.

Install

npm install -g @struktur/cli
bun install -g @struktur/cli

Verify:

struktur --help

Configure a provider (required)

Store your API key securely with the CLI:

echo "$OPENAI_API_KEY" | struktur config providers add openai --token-stdin

On macOS, tokens are stored in Keychain. On other platforms, ~/.config/struktur/tokens.json (chmod 600).

Quick setup with --default

echo "$OPENAI_API_KEY" | struktur config providers add openai --token-stdin --default

The --default flag automatically queries the provider API and sets the cheapest available model as default. One command, fully ready.

Set a default model

# Set explicitly
struktur config models use openai/gpt-4o-mini

# Or store a shortcut alias first
struktur config models alias set fast openai/gpt-4.1-mini
struktur config models use fast

Once set, --model is optional in extract commands.

Environment variables

You can set provider API keys as environment variables. Use this method for CI/CD pipelines and Docker containers. Environment variables override stored tokens. For regular use, stored tokens are recommended.

Provider API keys

VariableProvider
OPENAI_API_KEYOpenAI
ANTHROPIC_API_KEYAnthropic
GOOGLE_GENERATIVE_AI_API_KEYGoogle
OPENCODE_API_KEYOpenCode
OPENROUTER_API_KEYOpenRouter

Local providers

VariableProvider
OLLAMA_BASE_URLOllama (default: http://localhost:11434/api)

Custom endpoints

You can override the default API endpoint for OpenAI and Anthropic. Use custom endpoints for proxy servers and local models.

VariableProvider
OPENAI_BASE_URLOpenAI
ANTHROPIC_BASE_URLAnthropic

Configuration

VariablePurpose
STRUKTUR_CONFIG_DIROverride the config directory (default: ~/.config/struktur)
STRUKTUR_DISABLE_KEYCHAINSet to any value to force file-based token storage on macOS
STRUKTUR_KEYCHAIN_SERVICEOverride the Keychain service name

Debug and output

VariableEffect
NO_COLORSet to any value to disable colored output
CISet to any value to disable colored output (same effect as NO_COLOR)
DEBUGSet to any value to show debug messages
AI_SDK_LOG_WARNINGSSet to true to show AI SDK warnings

See also

  • extract — main extraction command
  • config — provider and model management

On this page