doubao-tui

Install and run the doubao and doubao-tui binaries from GitHub release artifacts.

Install

npm install -g doubao-tui
# or
pnpm add -g doubao-tui

For project-local usage:

npm install doubao-tui
npx doubao-tui --help

postinstall downloads platform binaries into bin/downloads/ and exposes doubao and doubao-tui commands.

First run

doubao login --api-key "YOUR_ARK_API_KEY"
doubao doctor
doubao

The doubao facade and doubao-tui binary share ~/.doubao/config.toml for Doubao auth and default model settings. Common TUI commands are available directly through the facade, including doubao doctor, doubao models, doubao sessions, and doubao resume --last.

The app talks to Volcengine Ark's OpenAI-compatible Chat Completions API. Set DOUBAO_BASE_URL only if you need to point at a compatible gateway.

NVIDIA NIM-hosted Doubao Seed Pro is also supported:

doubao auth set --provider nvidia-nim --api-key "YOUR_NVIDIA_API_KEY"
doubao --provider nvidia-nim

For a single process, set DOUBAO_PROVIDER=nvidia-nim and NVIDIA_API_KEY or NVIDIA_NIM_API_KEY (with DOUBAO_API_KEY as a compatibility fallback). The NIM default model is doubao-ai/doubao-seed-2-0-pro-260215 and the default base URL is https://integrate.api.nvidia.com/v1. With --provider nvidia-nim, --model doubao-seed-2-0-lite-260428 maps to doubao-ai/doubao-seed-2-0-lite-260428.

Supported platforms

Prebuilt binaries for the GitHub release are downloaded automatically:

• Linux x64
• Linux arm64 (v0.8.8+)
• macOS x64 / arm64
• Windows x64

Other platform/architecture combinations (musl, riscv64, FreeBSD, …) aren't shipped as prebuilts. The postinstall will exit with a clear error pointing you at cargo install doubao-tui-cli doubao-tui --locked and the full docs/INSTALL.md build-from-source guide.

Configuration

• Default binary version comes from doubaoBinaryVersion in package.json.
• Set DOUBAO_TUI_VERSION or DOUBAO_VERSION to override the release version.
• Set DOUBAO_TUI_GITHUB_REPO or DOUBAO_GITHUB_REPO to override the source repo (defaults to freestylefly/Doubao-TUI).
• Set DOUBAO_TUI_FORCE_DOWNLOAD=1 to force download even when the cached binary is already present.
• Set DOUBAO_TUI_DISABLE_INSTALL=1 to skip install-time download.
• Set DOUBAO_TUI_OPTIONAL_INSTALL=1 to make the postinstall step warn and exit 0 on download/extract errors instead of failing npm install (useful in CI matrices).

Release integrity

• npm publish runs a release-asset check to ensure all required binary assets exist for the target GitHub release before publishing.
• Install-time downloads are verified against the release checksum manifest before the wrapper marks them executable.
• Set DOUBAO_TUI_RELEASE_BASE_URL to point the installer at a local or staged release-asset directory for smoke tests.