Install Dictionary
Get up and running in minutes. Choose your preferred installation method based on your environment and workflow.
System Requirements
OS
macOS 12+, Ubuntu 20.04+, Windows 10+
Runtime
Node.js 18+ or Python 3.9+
Memory
Minimum 512MB RAM recommended
Network
Internet access for initial setup
1. Run the Installer
The fastest way to get Dictionary running is using our official installer script. It automatically detects your environment and sets up dependencies.
$ curl -fsSL https://install.dictionary.dev | sh
2. Verify Installation
Confirm Dictionary is properly installed by checking the version and running a quick health check.
$ dictionary --version Dictionary CLI v3.2.1 $ dictionary health ✓ All systems operational
Install via Package Manager
Use your OS package manager for system-wide installation with automatic updates.
$ npm install -g @dictionary/cli
$ pip install dictionary-core
$ brew install dictionary/cli/dictionary
Run with Docker
Containerized installation for consistent environments across development and production.
$ docker run -d \\ --name dictionary \\ -p 8080:8080 \\ -v dict-data:/app/data \\ dictionary/app:latest
Tip
Mount a volume to persist your dictionary database and custom configurations across container restarts.
Build from Source
For developers who need the latest features or want to contribute to the project.
$ git clone https://github.com/dictionary/dictionary-core.git $ cd dictionary-core $ npm install $ npm run build $ npm link
Development Mode
Running from source includes debug logging and unoptimized performance. Use only for development or testing.
Post-Installation Configuration
After installation, configure your API keys and preferences to unlock all features.
$ dictionary init # Follow the interactive setup wizard # Enter your API key when prompted $ dictionary config set --language en-US $ dictionary config set --mode developer
API Key Required
Generate a free API key from your dashboard to access premium definitions, translations, and AI-powered insights.
Common Issues
Command not found
Add the installation directory to your PATH or restart your terminal. For npm global installs, run npm config get prefix to locate it.
Slow initial startup
The first run downloads the language database (~45MB). Subsequent launches will be instant. Ensure you have a stable internet connection.