Hunter Bown
cd75ef886a
Closes #944\n\n## Summary\n- mark Docker/GHCR publishing as experimental while the package is not publicly readable\n- align installer and release docs with the live npm/Scoop state\n- keep package-channel verification explicit for release triage\n\n## Test plan\n- ruby -e 'require "yaml"; YAML.load_file(".github/workflows/release.yml"); puts "release.yml ok"'\n- cargo test -p deepseek-tui-cli update::tests::test_asset_matching_accepts_binary_assets_and_rejects_checksums --locked\n- cargo fmt --all -- --check\n- git diff --check origin/main...HEAD\n- CI: Version drift, Lint, Test (ubuntu-latest), Test (macos-latest), Test (windows-latest), npm wrapper smoke
79 lines
2.4 KiB
Markdown
79 lines
2.4 KiB
Markdown
# Docker
|
|
|
|
Docker support is currently a local-build/devcontainer path, not a supported
|
|
release channel. The release workflow may try an experimental GHCR publish, but
|
|
no public `ghcr.io/hmbown/deepseek-tui` image should be treated as available
|
|
until this page says so.
|
|
|
|
## Local quick start
|
|
|
|
Build the image locally from a checkout:
|
|
|
|
```bash
|
|
docker build -t deepseek-tui .
|
|
```
|
|
|
|
Then run it with your existing config directory mounted:
|
|
|
|
```bash
|
|
docker run --rm -it \
|
|
-e DEEPSEEK_API_KEY="$DEEPSEEK_API_KEY" \
|
|
-v ~/.deepseek:/home/deepseek/.deepseek \
|
|
deepseek-tui
|
|
```
|
|
|
|
Docker Hub publishing is not configured.
|
|
|
|
## Environment variables
|
|
|
|
| Variable | Required | Description |
|
|
|-----------------------|----------|--------------------------------------------------|
|
|
| `DEEPSEEK_API_KEY` | yes | DeepSeek API key |
|
|
| `DEEPSEEK_BASE_URL` | no | Custom API base URL (e.g. `https://api.deepseek.com`) |
|
|
| `DEEPSEEK_NO_COLOR` | no | Set to `1` to disable terminal colour output |
|
|
|
|
## Volumes
|
|
|
|
Mount `~/.deepseek` to persist sessions, config, skills, memory, and the offline queue
|
|
across container restarts:
|
|
|
|
```bash
|
|
-v ~/.deepseek:/home/deepseek/.deepseek
|
|
```
|
|
|
|
Without this mount the container starts fresh each time.
|
|
|
|
## Non-interactive / pipeline usage
|
|
|
|
When stdin is not a TTY, `deepseek` drops to the dispatcher's one-shot mode
|
|
(`deepseek -c "…"`). Pipe a prompt on stdin:
|
|
|
|
```bash
|
|
echo "Explain the Cargo.toml in structured English." | \
|
|
docker run --rm -i -e DEEPSEEK_API_KEY deepseek-tui
|
|
```
|
|
|
|
## Building locally
|
|
|
|
```bash
|
|
# Single platform (your host architecture)
|
|
docker build -t deepseek-tui .
|
|
|
|
# Multi-platform (requires a builder with emulation)
|
|
docker buildx create --use
|
|
docker buildx build --platform linux/amd64,linux/arm64 -t deepseek-tui .
|
|
```
|
|
|
|
## Devcontainer
|
|
|
|
The repository includes a [`.devcontainer/devcontainer.json`](../.devcontainer/devcontainer.json)
|
|
configuration for VS Code / GitHub Codespaces. It pre-installs the Rust toolchain,
|
|
rust-analyzer, and the `deepseek` binary. Open the repo in a devcontainer to get a
|
|
ready-to-use development environment.
|
|
|
|
## Release status
|
|
|
|
Docker image publishing is experimental and non-blocking for releases. The
|
|
supported distribution channels are npm, Cargo, Homebrew, GitHub Release
|
|
assets, and Scoop's independently maintained main-bucket manifest.
|