Skip to content

docs(agent-shell): update fork command syntax in readme - #358

Merged
designcode merged 2 commits into
mainfrom
claude/agent-shell-readme-fork
Oct 8, 2026
Merged

designcode merged 2 commits into
mainfrom
claude/agent-shell-readme-fork

Conversation

@claude

@claude claude Bot commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

Requested by Xe Iaso · Slack thread

Before: The @tigrisdata/agent-shell README still described the old fork commands: fork source-bucket my-fork with two positional arguments, and a separate forks my-bucket command for listing forks. The shell no longer has either form, so anyone who copied them got a usage error. The API table also listed a createForksListCommand export that the package no longer ships.

After: The README shows the commands that actually work: fork source-bucket --name my-fork, with optional --snapshot, and fork source-bucket --list. It also notes that you can leave out the bucket name when you're inside a mounted bucket. The createForksListCommand row is gone. While checking the rest of the README against the source, I fixed three more out-of-date spots: it now documents presign --key, which you need after login; it adds forcePathStyle to the TigrisConfig shape; and the Development section uses pnpm commands, since npm install fails in this workspace. A patch changeset for @tigrisdata/agent-shell is included so the corrected README reaches npm with the next release.

How: I checked the examples against packages/agent-shell/src/commands/fork.ts and the exports in src/commands/index.ts. The fork wording matches the docs-site fix in tigrisdata/tigris-os-docs#557. The examples/snapshot-and-fork.ts script also used the old positional form, so it now runs fork <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-shell docs 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-fork flow and the separate forks command with fork [<source-bucket>] --name <fork-name> (optional --snapshot) and fork … --list, including the cwd-mounted bucket case. It also documents presign --key, adds forcePathStyle to the TigrisConfig table, drops the createForksListCommand export row, and switches the Development section from npm to pnpm monorepo commands. examples/snapshot-and-fork.ts uses fork ${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.

claude added 2 commits October 7, 2026 17:39
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
Xe requested a review from designcode October 7, 2026 19:24
@Xe
Xe marked this pull request as ready for review October 7, 2026 19:24
@greptile-apps

greptile-apps Bot commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 5/5

[Low risk] Updates documentation and examples for the fork command.

The PR appears safe to merge; the corrected examples match the current code.

What we checked:

  • Fork examples match the command: fork accepts all the documented flags. It also resolves an omitted source bucket from the current mount.
  • Presign requires the documented key: login creates a config without an access key ID. presign requires the ID and accepts it through --key.

Summary

Updates the @tigrisdata/agent-shell README and fork example to match the current commands.

  • Documents fork --name, --snapshot, --list, and using the current mounted bucket.
  • Adds presign --key and forcePathStyle, and removes the stale export.
  • Uses pnpm development commands and adds a patch changeset.

Reviews (1) · Last reviewed commit: "docs(agent-shell): use fork --name in sn..." · Reviewed by Greptile

@designcode
designcode merged commit f5808a6 into main Oct 8, 2026
3 checks passed
@designcode
designcode deleted the claude/agent-shell-readme-fork branch October 8, 2026 07:14
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.

2 participants