DuckTape Documentation
Get up and running with DuckTape in just a few minutes. This guide will walk you through installation, configuration, and basic usage.
Installation
Install DuckTape using Homebrew:
brew install ducktapeai/ducktape/ducktapeConfigure Environment Variables
DuckTape requires API keys for at least one of the supported AI providers.
Required for AI Language Models:
Choose at least one of the following AI providers:
# For OpenAI
export OPENAI_API_KEY='your-openai-api-key-here'
# For Grok (XAI)
export XAI_API_KEY='your-xai-api-key-here'
# For DeepSeek
export DEEPSEEK_API_KEY='your-deepseek-api-key-here'Modes of Operation
DuckTape offers two distinct modes of operation:
1. Natural Language Mode (Requires API Key)
In this mode, DuckTape uses AI language models to interpret natural language commands. This requires setting up API keys for one of the supported AI providers:
Setting Up API Keys
Choose at least one provider and set the corresponding environment variable:
# For OpenAI
export OPENAI_API_KEY='your-openai-api-key-here'
# For Grok (XAI)
export XAI_API_KEY='your-xai-api-key-here'
# For DeepSeek
export DEEPSEEK_API_KEY='your-deepseek-api-key-here'2. Terminal Mode (No API Key Required)
In this mode, DuckTape operates as a traditional command-line interface (CLI) where you can directly execute commands without requiring any API keys.
Example Command
Create a calendar event using Terminal Mode:
ducktape calendar create "Team Meeting" 2025-04-15 10:00 11:00 "Work"Try It Out
Let's try a simple natural language command: