From c6d11608257250e23282c2d2c22605780dc80b3d Mon Sep 17 00:00:00 2001 From: mikefaut <30619604+mikefaut@users.noreply.github.com> Date: Wed, 24 Jun 2026 11:03:05 +0200 Subject: [PATCH] docs(files): document --region global for cp/download/ls/rm 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. --- internal/commands/files/cp.go | 3 ++- internal/commands/files/download.go | 3 ++- internal/commands/files/ls.go | 3 ++- internal/commands/files/rm.go | 3 ++- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/internal/commands/files/cp.go b/internal/commands/files/cp.go index 1125e12..e575b08 100644 --- a/internal/commands/files/cp.go +++ b/internal/commands/files/cp.go @@ -25,7 +25,8 @@ Examples: cerebrium cp local_file.txt # Upload to /local_file.txt cerebrium cp local_file.txt remote.txt # Upload to /remote.txt cerebrium cp local_dir/ remote_dir/ # Upload directory - cerebrium cp file.txt --region us-west-2 # Upload to specific region`, + cerebrium cp file.txt --region us-west-2 # Upload to specific region + cerebrium cp file.txt --region global # Upload to global storage`, Args: cobra.RangeArgs(1, 2), RunE: func(cmd *cobra.Command, args []string) error { return runCp(cmd, args, region) diff --git a/internal/commands/files/download.go b/internal/commands/files/download.go index 4ab513b..2df8a37 100644 --- a/internal/commands/files/download.go +++ b/internal/commands/files/download.go @@ -24,7 +24,8 @@ func NewDownloadCmd() *cobra.Command { Examples: cerebrium download remote_file.txt # Download to ./remote_file.txt cerebrium download remote.txt local.txt # Download to ./local.txt - cerebrium download file.txt --region us-west-2 # Download from specific region`, + cerebrium download file.txt --region us-west-2 # Download from specific region + cerebrium download file.txt --region global # Download from global storage`, Args: cobra.RangeArgs(1, 2), RunE: func(cmd *cobra.Command, args []string) error { return runDownload(cmd, args, region) diff --git a/internal/commands/files/ls.go b/internal/commands/files/ls.go index a35fdf7..f83c795 100644 --- a/internal/commands/files/ls.go +++ b/internal/commands/files/ls.go @@ -22,7 +22,8 @@ func NewLsCmd() *cobra.Command { Examples: cerebrium ls # List all files in the root directory cerebrium ls sub_folder/ # List all files in a specific directory - cerebrium ls --region us-west-2 # List files in a specific region`, + cerebrium ls --region us-west-2 # List files in a specific region + cerebrium ls --region global # List files in global storage`, Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { return runLs(cmd, args, region) diff --git a/internal/commands/files/rm.go b/internal/commands/files/rm.go index 989a78e..da43fbb 100644 --- a/internal/commands/files/rm.go +++ b/internal/commands/files/rm.go @@ -23,7 +23,8 @@ Examples: cerebrium rm /file_name.txt # Remove a specific file cerebrium rm /sub_folder/file_name.txt # Remove file in subdirectory cerebrium rm /sub_folder/ # Remove directory (must end with /) - cerebrium rm --region us-west-2 /file # Remove from specific region`, + cerebrium rm --region us-west-2 /file # Remove from specific region + cerebrium rm --region global /file # Remove from global storage`, Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { return runRm(cmd, args, region)