Skip to content

docs(files): document --region global for cp/download/ls/rm#84

Open
mikefaut wants to merge 1 commit into
mainfrom
feat/global-region-docs
Open

docs(files): document --region global for cp/download/ls/rm#84
mikefaut wants to merge 1 commit into
mainfrom
feat/global-region-docs

Conversation

@mikefaut

Copy link
Copy Markdown

Summary

  • Adds a `--region global` usage example to the `Long` description of `cp`, `download`, `ls`, and `rm`.
  • No functional change: `--region` is already a free-form string flag and `runCp` / `runLs` / `runRm` / `runDownload` pass the value through to the API client unchanged. `region=global` reaches the backend the moment the backend recognises it.

Backend companion PR: CerebriumAI/dashboard-backend#3840

Test plan

  • `go build ./...` succeeds (verified locally)
  • `cerebrium cp --help` shows the new example line under `cp`
  • Same for `download --help`, `ls --help`, `rm --help`
  • Once the backend PR is deployed to dev, `cerebrium cp file.txt --region global` against dev uploads to the global bucket and `ls --region global` lists it

The --region flag is already free-form, so `--region global` works once
the backend recognises it. This adds a usage example to each command's
Long description so the option is discoverable.
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