dgf1988/codewhale

Files

T

Hunter Bown a3acdbe70b docs(brand): rename to codewhale across READMEs and docs

Sweep brand mentions of `DeepSeek TUI` / `deepseek-tui` / bare
`deepseek` (the dispatcher binary) across all user-facing docs to
the new `codewhale` brand. The DeepSeek **provider** integration is
left untouched throughout: env vars (`DEEPSEEK_*`), model IDs
(`deepseek-v4-pro`, `deepseek-v4-flash`, `deepseek-chat`,
`deepseek-reasoner`), the `api.deepseek.com` host, the
`~/.deepseek/` config dir, and the `--provider deepseek` argument
value all keep the legacy spelling.

Anti-scope items deliberately left as the legacy `deepseek-tui`:

- Homebrew tap and formula (`Hmbown/homebrew-deepseek-tui`,
  `brew install deepseek-tui`, `scoop install deepseek-tui`). The
  tap rename ships separately.
- Docker image (`ghcr.io/hmbown/deepseek-tui`). Image-tag rename
  ships separately.
- CNB mirror namespace (`cnb.cool/deepseek-tui.com/DeepSeek-TUI`).
  Third-party hosted path.
- Security contact email (`security@deepseek-tui.com`).
- GitHub repo URL (`Hmbown/DeepSeek-TUI`).

New artifact:

- `docs/REBRAND.md` documents what changed, what didn't, the
  deprecation window, and migration commands for npm / Cargo /
  Homebrew / manual installs.

CHANGELOG entries:

- Root `CHANGELOG.md` and `crates/tui/CHANGELOG.md` both gain a
  new `[Unreleased]` section describing the rename and the one-
  release deprecation window. Historical entries are untouched.

Issue templates:

- `.github/ISSUE_TEMPLATE/bug_report.md` and `feature_request.md`
  refer to "codewhale" / `codewhale --version` instead of the old
  brand name in their environment fields.

The rebrand sweep was driven by a perl script with bulk patterns
(`deepseek-tui` -> `codewhale-tui`, `DeepSeek TUI` -> `codewhale`,
bare `deepseek` -> `codewhale` with provider/model/host/env-var/
config-path negative lookbehind/lookahead) followed by targeted
reverts for the anti-scope items above. Output was visually
reviewed file-by-file before committing.

Verified:

- `cargo check --workspace --all-targets --locked` — pass.
- `cargo test --workspace --all-features --locked` — pass (no
  test source touched here; suite stayed green to confirm no
  doc-from-string assertions broke).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

2026-05-23 11:25:48 -05:00

5.2 KiB

Raw Blame History

Tencent Cloud Remote-First Quickstart

This is the opinionated Tencent-native teaching path for codewhale users who want an always-on agent workspace, a phone control surface, and a stack that works well from mainland China.

It complements the local install path. If you only want to use codewhale on a laptop, start with the README quickstart. If you want "DS-TUI as a remote workbench I can control from my phone", start here.

Default Stack

GitHub main/tags
  -> CNB mirror: cnb.cool/deepseek-tui.com/DeepSeek-TUI
  -> optional CNB build/deploy pipeline
  -> Tencent Lighthouse HK
       /opt/whalebro/codewhale-tui
       /opt/whalebro/worktrees
       codewhale-runtime.service on 127.0.0.1:7878
       codewhale-feishu-bridge.service
  -> Feishu/Lark phone DM

EdgeOne is optional:
  public HTTPS domain -> EdgeOne -> Caddy/Nginx on Lighthouse

What Each Piece Does

CNB is the Tencent-side source and automation lane. The existing cnb.cool mirror is useful for clones and tagged installs when GitHub is slow. Optional CNB deploy templates live under deploy/tencent-lighthouse/cnb/.
Lighthouse is the private always-on host. It owns /opt/whalebro, systemd, Rust/Node installs, and the codewhale serve --http runtime.
Feishu/Lark is the first phone UI. The bridge uses long-connection mode, so the first setup does not need a public webhook URL.
EdgeOne is the public edge only when you intentionally expose a web surface such as docs, a status page, or a future webhook endpoint. Do not put the runtime API behind EdgeOne.

First Lesson: Get a Remote Agent Running

Buy or reuse a Tencent Lighthouse instance in Hong Kong.
Clone from CNB by default when the branch or tag exists there:
```
export DEEPSEEK_REPO_URL=https://cnb.cool/deepseek-tui.com/DeepSeek-TUI.git
git ls-remote "$DEEPSEEK_REPO_URL" refs/heads/main
```
Tencent setup branches matching work/v*-feishu-* or work/v*-lighthouse* are mirrored by the GitHub CNB sync workflow. Use the GitHub URL only when the CNB workflow or credentials are unhealthy.

Bootstrap /opt/whalebro on the server:

export DEEPSEEK_BRANCH=main
git clone --branch "$DEEPSEEK_BRANCH" "$DEEPSEEK_REPO_URL" /tmp/codewhale-tui
cd /tmp/codewhale-tui
sudo DEEPSEEK_REPO_URL="$DEEPSEEK_REPO_URL" \
  DEEPSEEK_REPO_BRANCH="$DEEPSEEK_BRANCH" \
  bash scripts/tencent-lighthouse/bootstrap-ubuntu.sh

Install Rust for the codewhale user, build both binaries, and install the systemd units using docs/TENCENT_LIGHTHOUSE_HK.md.
Configure a Feishu/Lark self-built app, fill /etc/deepseek/feishu-bridge.env, run the validator, then run the VPS doctor.
From your phone DM, validate /status, a harmless prompt, /interrupt, /threads, /resume, approval allow/deny, service restart, and reboot persistence.

Second Lesson: Make CNB the Deploy Button

Once the manual Lighthouse path works, copy the non-active examples from deploy/tencent-lighthouse/cnb/ into the CNB repository:

cnb.yml.example -> .cnb.yml
tag_deploy.yml.example -> .cnb/tag_deploy.yml

The intended deploy button should:

Run bridge validation/tests and lightweight release-version checks.
SSH to Lighthouse with a deploy key stored as a CNB secret.
Update /opt/whalebro/codewhale-tui.
Rebuild/install both binaries.
Reinstall/restart systemd services.
Run scripts/tencent-lighthouse/doctor.sh.

Do not enable this on main until the deploy key, target host, billing/quota, and rollback policy are explicit.

Third Lesson: Add EdgeOne Only For Public HTTPS

The Feishu/Lark long-connection bridge works without EdgeOne. Add EdgeOne when you want a public domain in front of a deliberate HTTP service:

a public tutorial/docs site
a small operator status page
a future webhook-mode bridge
a demo app running on the same Lighthouse origin

Keep these rules:

codewhale serve --http stays bound to 127.0.0.1.
/v1/* runtime endpoints are never public.
DEEPSEEK_RUNTIME_TOKEN never leaves the server env files.
Feishu/Lark group control stays off until a specific group allowlist is set.
Auto-approval stays off for the phone bridge unless a maintainer explicitly accepts the risk.

Teaching Order

Use this sequence when explaining codewhale to a new remote-first user:

Local mental model: codewhale is the dispatcher, codewhale-tui is the companion runtime, and both binaries matter.
Agent safety: Plan/Agent/YOLO are separate from approval mode and sandboxing.
Remote runtime: codewhale serve --http is a localhost runtime API, not a public web app.
Phone bridge: Feishu/Lark messages become runtime requests through an allowlisted bridge.
CNB automation: once manual setup is proven, CNB turns the setup into a repeatable deploy button.
EdgeOne edge: add the public edge after you know exactly what public surface you are exposing.

References

CNB mirror details: docs/CNB_MIRROR.md
Lighthouse implementation runbook: docs/TENCENT_LIGHTHOUSE_HK.md
Feishu/Lark bridge: integrations/feishu-bridge/README.md
CNB templates: deploy/tencent-lighthouse/cnb/

5.2 KiB Raw Blame History