Skip to content

docs: feature forkd doctor / from-image / bench in Quick start#137

Merged
WaylandYang merged 1 commit into
mainfrom
docs/readme-feature-new-cli-commands
May 21, 2026
Merged

docs: feature forkd doctor / from-image / bench in Quick start#137
WaylandYang merged 1 commit into
mainfrom
docs/readme-feature-new-cli-commands

Conversation

@WaylandYang
Copy link
Copy Markdown
Contributor

Summary

The three CLI commands shipped today (#134 doctor, #135 bench, #136 from-image) collapse the new-user setup from 4 hand-pasted commands into a single `forkd doctor` + `forkd from-image` flow. Quick start in both READMEs didn't reflect that yet — anyone landing from a Twitter / blog link would see the old multi-step path. Fixed.

Before

Quick start showed only:

  • Hub-pull path (`forkd pull deeplethe/langgraph-react`)
  • From-source path (build forkd from cargo, run `scripts/build-rootfs.sh` manually, snapshot manually, fork)

After (new subsections, in order)

  1. Confirm your host is ready — leads with `forkd doctor` after setup-host.sh
  2. Fastest path — Hub pull (unchanged)
  3. From a Docker image (one command) — new, uses `forkd from-image python:3.12-slim --tag py-numpy --extra python3-numpy`
  4. Probe your install's latency — new, shows `forkd bench` output
  5. From-source path (unchanged)
  6. Multi-child fork-out (unchanged)

README-zh.md gets parallel sections (一/二/三/四).

Files

  • `README.md` — +43 / −1 lines
  • `README-zh.md` — +45 / −0 lines

No code changes.

🤖 Generated with Claude Code

…start

The 3 CLI commands shipped 2026-05-21 (#134, #135, #136) collapse the
new-user setup from 4 hand-pasted commands to a single \`forkd doctor\`
+ \`forkd from-image\` flow. Surface this prominently in Quick start so
visitors landing from a Twitter / blog link see the modern story.

- README.md: new \"Confirm your host is ready\" subsection leads with
  \`forkd doctor\`. New \"From a Docker image (one command)\" subsection
  shows \`forkd from-image python:3.12-slim --tag py-numpy\`. New
  \"Probe your install's latency\" subsection shows \`forkd bench\` with
  example output.
- README-zh.md: parallel sections in Chinese.

The original Hub-pull, from-source, and multi-child-fork-out sections
are unchanged — those audiences still need them. New subsections come
first since they're the most-likely user path.

No code changes.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@WaylandYang WaylandYang force-pushed the docs/readme-feature-new-cli-commands branch from c6b9974 to e188d5f Compare May 21, 2026 05:56
@WaylandYang WaylandYang merged commit 085bd90 into main May 21, 2026
4 checks passed
@WaylandYang WaylandYang deleted the docs/readme-feature-new-cli-commands branch May 21, 2026 07:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant