View on GitHub

Environment Variables

DuckTape requires certain environment variables to be set in order to use its AI features and integrations. This guide explains which environment variables you need and how to set them up.

Required API Keys

AI Language Models

DuckTape uses AI language models to understand natural language commands. You need at least one of the following API keys:

# For OpenAI (GPT models)
export OPENAI_API_KEY='your-openai-api-key-here'

# For Grok (X.AI)
export XAI_API_KEY='your-xai-api-key-here'

# For DeepSeek
export DEEPSEEK_API_KEY='your-deepseek-api-key-here'

How to obtain API keys:

  • OpenAI API Key: Visit OpenAI Platform, create an account, and generate an API key.
  • Grok (X.AI) API Key: Available through X.AI for subscribers.
  • DeepSeek API Key: Create an account on DeepSeek and generate an API key.

Zoom Integration (Optional)

To enable automatic Zoom meeting creation in calendar events, you need to set up the following environment variables:

# Zoom credentials
export ZOOM_ACCOUNT_ID='your-zoom-account-id'
export ZOOM_CLIENT_ID='your-zoom-client-id'
export ZOOM_CLIENT_SECRET='your-zoom-client-secret'

How to obtain Zoom API credentials:

  1. Go to Zoom App Marketplace and log in.
  2. Click "Develop" in the top-right and select "Build App".
  3. Select "Server-to-Server OAuth" app type.
  4. Fill in the required information about your app.
  5. In the "Scopes" section, add the following scopes:
    • meeting:write:admin or meeting:write
  6. Save and activate your app.
  7. Find your Account ID, Client ID, and Client Secret in the app credentials section.
For more details on setting up Zoom integration, see the Zoom Integration documentation.

Custom Configuration Variables

Optional Configuration

These environment variables are optional and allow you to customize DuckTape's behavior:

Variable Description Default
DUCKTAPE_DEFAULT_CALENDAR The default calendar to use when not specified Calendar
DUCKTAPE_DEFAULT_REMINDER_LIST The default reminder list to use Reminders
DUCKTAPE_LOG_LEVEL Logging level (error, warn, info, debug, trace) info
DUCKTAPE_CONFIG_DIR Directory for configuration files ~/.config/ducktape

Setting Up Environment Variables

For Temporary Use

You can set environment variables for the current terminal session:

export OPENAI_API_KEY='your-openai-api-key-here'

For Persistent Use

To make environment variables persist across terminal sessions, add them to your shell configuration file:

# Add these lines to your ~/.zshrc, ~/.bashrc, or ~/.bash_profile
export OPENAI_API_KEY='your-openai-api-key-here'
export ZOOM_ACCOUNT_ID='your-zoom-account-id'
export ZOOM_CLIENT_ID='your-zoom-client-id'
export ZOOM_CLIENT_SECRET='your-zoom-client-secret'

After editing your shell configuration file, reload it:

# For Bash
source ~/.bashrc

# For Zsh
source ~/.zshrc
Security Note: Keep your API keys secure and never share them publicly. Consider using a more secure method like environment variable management tools or credential managers for production environments.

Verifying Configuration

To verify that your environment variables are correctly set, use the ducktape config show command:

Terminal
$ ducktape config show
DuckTape Configuration:
- Language Model: OpenAI
- Default Calendar: Work
- Default Reminder List: Personal
- Zoom Integration: Enabled
$ |