Installation

CLI

Choose the installer for your platform or install from source if you want to build the CLI locally.

macOS / Linux

curl --proto '=https' --tlsv1.2 -LsSf https://odict.org/install.sh | sh

This shell installer downloads the latest release binary for macOS or Linux.

Homebrew

brew install TheOpenDictionary/odict/odict

Homebrew is the simplest option on macOS.

Windows

powershell -ExecutionPolicy ByPass -c "irm https://github.com/TheOpenDictionary/odict/releases/latest/download/odict-installer.ps1 | iex"

From source

git clone https://github.com/TheOpenDictionary/odict.git
cd odict
# Requires Rust 1.75+.
cargo install --path cli

Verify the CLI

odict --version

Language bindings

Install the package for the language you are using.

Python

pip install theopendictionary

Requires Python 3.8.1+. See the Python API docs for usage.

JavaScript

npm install @odict/node

Requires Node.js 12+. The package includes native binaries for all major platforms. See the JavaScript API docs for usage.

Rust

Add the crate to your Cargo.toml:

[dependencies]
odict = "3"

See the Rust API docs for usage and feature flags.