Repository navigation
docs(agent-shell): update fork command syntax in readme - #358
Merged
Merged
Conversation
The README still showed the old positional `fork <src> <dst>` form, a separate `forks` command, and a `createForksListCommand` export, none of which exist anymore. Document `fork [<source-bucket>] --name <fork> [--snapshot <version>]` and `fork <source-bucket> --list`, drop the removed export, and fix a few other drifted spots: add `presign --key`, add `forcePathStyle` to the `TigrisConfig` shape, and switch the development commands from npm to pnpm. Assisted-by: Claude Opus 5.5 via Claude Code Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015Qg5NUvpUUpqnqd6ow5Xdv
The example still called `fork <src> <dst>` with two positional arguments, which the current fork command rejects. Pass the fork name with `--name` instead. Assisted-by: Claude Opus 5.5 via Claude Code Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015Qg5NUvpUUpqnqd6ow5Xdv
Xe
marked this pull request as ready for review
October 7, 2026 19:24
Contributor
|
designcode
approved these changes
Oct 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requested by Xe Iaso · Slack thread
Before: The
@tigrisdata/agent-shellREADME still described the old fork commands:fork source-bucket my-forkwith two positional arguments, and a separateforks my-bucketcommand for listing forks. The shell no longer has either form, so anyone who copied them got a usage error. The API table also listed acreateForksListCommandexport that the package no longer ships.After: The README shows the commands that actually work:
fork source-bucket --name my-fork, with optional--snapshot, andfork source-bucket --list. It also notes that you can leave out the bucket name when you're inside a mounted bucket. ThecreateForksListCommandrow is gone. While checking the rest of the README against the source, I fixed three more out-of-date spots: it now documentspresign --key, which you need afterlogin; it addsforcePathStyleto theTigrisConfigshape; and the Development section uses pnpm commands, sincenpm installfails in this workspace. A patch changeset for@tigrisdata/agent-shellis included so the corrected README reaches npm with the next release.How: I checked the examples against
packages/agent-shell/src/commands/fork.tsand the exports insrc/commands/index.ts. The fork wording matches the docs-site fix in tigrisdata/tigris-os-docs#557. Theexamples/snapshot-and-fork.tsscript also used the old positional form, so it now runsfork <bucket> --name <fork>too.🤖 Generated with Claude Code
https://claude.ai/code/session_015Qg5NUvpUUpqnqd6ow5Xdv
Note
Low Risk
Documentation and example-only changes with no runtime or API behavior modifications.
Overview
Aligns
@tigrisdata/agent-shelldocs and the snapshot/fork example with the current CLI, so copy-paste commands stop failing with usage errors.The README replaces the old positional
fork source-bucket my-forkflow and the separateforkscommand withfork [<source-bucket>] --name <fork-name>(optional--snapshot) andfork … --list, including the cwd-mounted bucket case. It also documentspresign --key, addsforcePathStyleto theTigrisConfigtable, drops thecreateForksListCommandexport row, and switches the Development section from npm to pnpm monorepo commands.examples/snapshot-and-fork.tsusesfork ${bucket} --name ${forkName}. A patch changeset records the README fix for the next npm release.Reviewed by Cursor Bugbot for commit 9ba2275. Bugbot is set up for automated code reviews on this repo. Configure here.