Repository navigation
docs(cli): add the missing command pages and flags - #562
Conversation
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Assisted-by: Claude Fable 5.1 via Claude Code
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
 |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| This cannot be undone: a purged bucket can no longer be restored with | ||
| [`tigris buckets restore`](/docs/cli/buckets/restore). Only buckets that are | ||
| already soft-deleted can be purged — for a live bucket the command fails rather | ||
| than deleting it. List the candidates with | ||
| [`tigris buckets list --deleted`](/docs/cli/buckets/list). |
There was a problem hiding this comment.
The irreversible-delete warning is ordinary paragraph text. The repository requires important warnings in .mdx files to use callouts. Wrap this warning in :::warning so it stands out before the --yes examples. The permanent-deletion warning in snapshots/delete.mdx needs the same change. This requirement must be satisfied before merging.
Rule Used: Convert important information or warnings in documentation files (.mdx) into proper note callouts instead of inline text. (source)
Learned From
tigrisdata/tigris-os-docs#280
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
| | `--enable-delete-protection` | No | — | Enable delete protection | | ||
| | `--default-tier` | No | — | Change the default storage tier for objects uploaded to the bucket. Options: `STANDARD`, `STANDARD_IA`, `GLACIER`, `GLACIER_IR` | | ||
| | `--soft-delete` | No | — | Enable or disable [soft delete](/docs/buckets/soft-delete) (recoverable deletes). Options: `enable`, `disable`. Enabling requires `--retention-days` | | ||
| | `--retention-days` | No | — | Number of days to retain soft-deleted objects (required when enabling `--soft-delete`) | |
There was a problem hiding this comment.
The new --retention-days description omits its valid range. The linked soft-delete guide says it must be between 7 and 90, and values outside that range fail the request. Add those bounds to the flag row so readers can choose a valid value without leaving this reference.
| | `--bucket`, `-b` | No | — | Bucket to grant access to (comma-separated for several). Each bucket is paired positionally with a `--role` value | | ||
| | `--role`, `-r` | No | — | Role to assign (comma-separated for several). Each role pairs with the corresponding `--bucket` value. See [`access-keys assign`](/docs/cli/access-keys/assign) for the roles | | ||
| | `--admin` | No | — | Grant admin access to all buckets in the organization | | ||
| | `--env` | No | — | Write the credentials to a dotenv file, merging into it when it already exists. Defaults to `./.env`. The secret is then not printed | |
There was a problem hiding this comment.
The new --env row and examples only show the default-file form. The changelog documents --env [path]. Add that syntax and a custom-file example so readers know how to write credentials to a file such as .env.local.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
| Telemetry is on by default. It is a per-machine setting: turning it off here | ||
| does not affect other machines you use the CLI on. |
There was a problem hiding this comment.
The new telemetry pages only explain machine-setting commands. The changelog also documents TIGRIS_NO_TELEMETRY and DO_NOT_TRACK. Add those options here so readers configuring CI through environment variables can find the supported opt-out method.
| Telemetry is on by default. It is a per-machine setting: turning it off here | |
| does not affect other machines you use the CLI on. | |
| Telemetry is on by default. It is a per-machine setting: turning it off here | |
| does not affect other machines you use the CLI on. | |
| :::note | |
| The environment variables `TIGRIS_NO_TELEMETRY` and `DO_NOT_TRACK` can also | |
| turn telemetry off. Both accept any truthy value. | |
| ::: |
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
| See the [CLI quickstart for AI agents](/docs/ai-agents/tigris-cli-quickstart) | ||
| for what the setup configures. |
There was a problem hiding this comment.
The linked CLI quickstart does not explain what tigris init configures. It covers storage commands but never discusses tigris init, MCP setup, or skill installation. Link to a guide that covers those changes, or explain the configured files here.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
This branch was successfully deployed
2 participants
Summary
Brings the CLI reference in line with the current
specs.yamlintigrisdata/storage(as offeat(cli): show monthly usage and chargesonmain, plus the open purge PR). Diffed the full command tree and every flag againstdocs/cli/**; nothing documented turned out stale, but 13 commands had no page and 14 pages were missing flags.New pages
tigris usage,tigris organizations delete,tigris buckets restore,tigris buckets purge,tigris buckets share,tigris buckets enable-snapshots,tigris buckets disable-snapshots,tigris snapshots delete,tigris init, andtigris telemetrywith itsstatus/disable/enablesubpages.Flags added to existing pages
access-keys create:--bucket --role --admin --env --export --for, with examples for each export modebuckets list:--deleted --forks-of --forks-only --owner --limit --page-tokenbuckets set:--default-tier --soft-delete --retention-days --enable-additional-headersbuckets migrate:--max-in-flight-gb--snapshot-versiononls,objects list,presign,objects restore,objects restore-info;--sourceonobjects list--cache-controloncpandobjects put--limit --page-tokenonls,snapshots list,access-keys list,iam policies listNavigation
buckets,organizations(new) andsnapshots(new) list every subcommand;objects setcarries a Deprecated admonition;sidebars.jshas entries for all new pages.Notes
buckets purgedocuments feat(storage): purge soft-deleted buckets storage#360, which is still open;usageandorganizations deletelanded on the CLI'smainthis week. Worth merging once those are in a published CLI release.npm run lintpasses and every link in the new/changed pages resolves. The fullnpm run buildfails locally on/docs/cli/because theCliShellcomponent cannot resolve@xterm/xterm/css/xterm.cssduring static rendering — unrelated to this change (both bundles compile, so the MDX is valid).🤖 Generated with Claude Code
Note
Low Risk
Changes are limited to MDX documentation and sidebar navigation; no application or CLI runtime code is modified.
Overview
Documentation-only update that aligns the CLI reference with the current command spec: it adds missing command pages, documents previously undocumented flags on existing pages, and wires everything into the docs sidebar.
New reference pages cover
tigris init,usage,organizations delete, bucket soft-delete workflows (restore,purge), sharing, snapshot bucket toggles (enable-snapshots/disable-snapshots),snapshots delete, and thetelemetrygroup (status,enable,disable). Parent pages for buckets, organizations, and snapshots now list their full subcommand sets.Existing pages gain flag tables and examples for scoped access-key creation and credential export (
--bucket,--role,--admin,--env,--export,--for), richer bucket list/set/migrate options,--cache-controlon uploads/copies,--snapshot-version(and related listing/source flags) across ls/objects/presign/restore flows, and--limit/--page-tokenon several list commands.objects setis marked deprecated in favor ofset-accessandmv.Navigation in
sidebars.jsadds entries for all new pages under the CLI section.Reviewed by Cursor Bugbot for commit 7c0265c. Bugbot is set up for automated code reviews on this repo. Configure here.