wehub-resource-sync
d68f003000
CI / Change detection (push) Has been cancelled
CI / Version drift (push) Has been cancelled
CI / Lint (push) Has been cancelled
CI / Workflow RLM cache (push) Has been cancelled
CI / Test (macos-latest) (push) Has been cancelled
CI / Test (ubuntu-latest) (push) Has been cancelled
CI / Test (windows-latest) (push) Has been cancelled
CI / npm wrapper smoke (push) Has been cancelled
CI / Mobile runtime smoke (push) Has been cancelled
CI / Workflow lint (push) Has been cancelled
CI / Documentation (push) Has been cancelled
Web Frontend / Lint & Type Check (push) Failing after 1s
Auto-close harvested PRs / close (push) Failing after 1s
cargo-deny / cargo-deny (bans licenses sources) (push) Failing after 1s
Security audit / cargo-audit (push) Failing after 1s
Sync to CNB / sync (push) Failing after 1s
cargo-deny / cargo-deny (advisories) (push) Failing after 3s
Web Frontend / Deploy to Cloudflare (push) Has been cancelled
119 lines
5.2 KiB
Markdown
119 lines
5.2 KiB
Markdown
# codewhale
|
|
|
|
> The terminal coding agent for any model — open models first.
|
|
|
|
CodeWhale is a Rust TUI and CLI for many model providers — DeepSeek,
|
|
OpenRouter, Hugging Face, and local vLLM/SGLang/Ollama are first-class routes,
|
|
and it speaks natively to Anthropic Claude and OpenAI when that's what you have
|
|
— with approval-gated tools, OS sandboxing, side-git snapshots, and `/restore`
|
|
rollback.
|
|
|
|
This npm package is a small launcher: it downloads the matching native
|
|
CodeWhale binaries for your platform, verifies them against the release
|
|
SHA-256 manifest, and installs the `codewhale`, `codew`, and `codewhale-tui`
|
|
commands. The application state and credentials still live in CodeWhale's
|
|
normal config files, not inside `node_modules`.
|
|
|
|
> Previously published as `deepseek-tui`. See
|
|
> [docs/REBRAND.md](https://github.com/Hmbown/CodeWhale/blob/main/docs/REBRAND.md)
|
|
> for the migration notes; the legacy `deepseek-tui` npm package is deprecated
|
|
> and receives no further releases.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
npm install -g codewhale
|
|
# or
|
|
pnpm add -g codewhale
|
|
```
|
|
|
|
For project-local usage:
|
|
|
|
```bash
|
|
npm install codewhale
|
|
npx codewhale --help
|
|
```
|
|
|
|
`postinstall` tries to download platform binaries into `bin/downloads/`. If
|
|
GitHub release assets are temporarily unreachable, install continues and the
|
|
wrapper retries the download on first run.
|
|
|
|
## First run
|
|
|
|
```bash
|
|
codewhale auth set --provider deepseek
|
|
codewhale auth status
|
|
codewhale doctor
|
|
codewhale
|
|
```
|
|
|
|
Every provider is the same one-line shape — `--provider openrouter`,
|
|
`--provider huggingface`, `--provider ollama`, or `--provider anthropic` for a
|
|
Claude key; the full registry lives in
|
|
[docs/PROVIDERS.md](https://github.com/Hmbown/CodeWhale/blob/main/docs/PROVIDERS.md).
|
|
|
|
The `codewhale` facade and `codewhale-tui` binary share
|
|
`~/.codewhale/config.toml` for auth and default model settings. Legacy
|
|
`~/.deepseek/config.toml` installs are still read as a compatibility fallback.
|
|
Common TUI commands are available directly through the facade, including
|
|
`codewhale doctor`, `codewhale models`, `codewhale sessions`, and
|
|
`codewhale resume --last`.
|
|
|
|
## Supported platforms
|
|
|
|
Prebuilt binaries for the GitHub release are downloaded automatically:
|
|
|
|
- Linux x64
|
|
- Linux arm64
|
|
- macOS x64 / arm64
|
|
- Windows x64
|
|
|
|
HarmonyOS PC (`openharmony`) is treated as `linux`, so it gets the Linux
|
|
binaries matching your CPU architecture (x64 or arm64). Linux riscv64 prebuilts
|
|
are temporarily paused while the locked `rquickjs-sys` dependency lacks
|
|
`riscv64gc-unknown-linux-gnu` bindings. Other platform/architecture combinations
|
|
(musl, FreeBSD, …) aren't shipped as prebuilts. Unsupported platforms, checksum
|
|
failures, and glibc compatibility problems still fail with a clear error pointing
|
|
you at the full
|
|
[docs/INSTALL.md](https://github.com/Hmbown/CodeWhale/blob/main/docs/INSTALL.md)
|
|
guide.
|
|
|
|
## Wrapper configuration
|
|
|
|
| Setting | What it does |
|
|
| --- | --- |
|
|
| `codewhaleBinaryVersion` in `package.json` | Default native binary version. `deepseekBinaryVersion` is still read as a backward-compat fallback. |
|
|
| `CODEWHALE_RELEASE_BASE_URL` | Canonical override: use an internal or mirrored release-asset directory when GitHub Releases is unavailable. The directory must contain `codewhale-artifacts-sha256.txt` and the platform binaries. `DEEPSEEK_TUI_RELEASE_BASE_URL` and `DEEPSEEK_RELEASE_BASE_URL` are the implemented legacy fallbacks. |
|
|
| `CODEWHALE_USE_CNB_MIRROR=1` | Download release assets from the CNB (China-friendly) mirror instead of GitHub. |
|
|
| `DEEPSEEK_TUI_VERSION` or `DEEPSEEK_VERSION` | Override the GitHub release version to download. |
|
|
| `DEEPSEEK_TUI_GITHUB_REPO` or `DEEPSEEK_GITHUB_REPO` | Override the source repo. Defaults to `Hmbown/CodeWhale`. |
|
|
| `DEEPSEEK_TUI_FORCE_DOWNLOAD=1` | Force download even when the cached binary is already present. |
|
|
| `DEEPSEEK_TUI_DISABLE_INSTALL=1` | Skip install-time download. |
|
|
| `DEEPSEEK_TUI_OPTIONAL_INSTALL=1` | Make install-time retryable download failures warn and exit `0` instead of failing `npm install`. |
|
|
| `DEEPSEEK_TUI_SKIP_GLIBC_CHECK=1` | Bypass the Linux glibc preflight check at your own risk (`DEEPSEEK_SKIP_GLIBC_CHECK=1` also works). |
|
|
|
|
### Proxies
|
|
|
|
Downloads respect `HTTPS_PROXY` / `HTTP_PROXY` (CONNECT tunneling included)
|
|
and `NO_PROXY`, so the wrapper works behind corporate proxies. For fully
|
|
offline installs, set `DEEPSEEK_TUI_DISABLE_INSTALL=1` or point
|
|
`CODEWHALE_RELEASE_BASE_URL` at a local mirror.
|
|
|
|
## Release integrity
|
|
|
|
- `npm publish` runs a release-asset check to ensure all required binary assets
|
|
exist for the target GitHub release before publishing.
|
|
- For the default GitHub Release source, `npm run release:check` also verifies
|
|
that the npm-facing assets were updated by a successful `release.yml` run for
|
|
the tag commit. When `CODEWHALE_RELEASE_BASE_URL` or a legacy mirror override
|
|
is set, it checks the mirror asset URLs and checksum manifest instead.
|
|
- Install-time downloads are verified against the release checksum manifest before
|
|
the wrapper marks them executable.
|
|
|
|
## Links
|
|
|
|
- Repository: <https://github.com/Hmbown/CodeWhale>
|
|
- Website: <https://codewhale.net/>
|
|
- Provider registry: [docs/PROVIDERS.md](https://github.com/Hmbown/CodeWhale/blob/main/docs/PROVIDERS.md)
|
|
- Changelog: [CHANGELOG.md](https://github.com/Hmbown/CodeWhale/blob/main/CHANGELOG.md)
|