Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

Cli reference doc updates | added examples to the storage section (#41728)

TheOtherBrian1549bd1460448
diff --git a/apps/docs/spec/cli_v1_commands.yaml b/apps/docs/spec/cli_v1_commands.yaml
index 933fdd62b2b..f5e66e5df5d 100644
--- a/apps/docs/spec/cli_v1_commands.yaml
+++ b/apps/docs/spec/cli_v1_commands.yaml
@@ -349,6 +349,35 @@ commands:
- id: supabase-storage-cp
title: supabase storage cp
summary: Copy objects from src to dst path
+ description: |
+ Relies on standard uploads to move files between local and remote storage. [Not suitable for moving files over 6MB in size](https://supabase.com/docs/guides/storage/uploads/standard-uploads?queryGroups=language&language=js#uploading).
+ examples:
+ - id: upload-file-to-bucket
+ name: Upload file to bucket
+ code: supabase storage cp -r path/to/file ss:///bucket_name --experimental
+ response: |
+ Uploading: /path/to/file/example.txt => /bucket_name/example.txt
+ - id: Upload-file-to-folder
+ name: Upload file to folder
+ code: supabase storage cp -r path/to/local/file ss:///bucket_name/path/to/folder --experimental
+ response: |
+ Uploading: /path/to/file/example.txt => /bucket_name/path/to/folder/example.txt
+ - id: upload-entire-folder-to-bucket
+ name: Upload folder to bucket
+ code: supabase storage cp -r path/to/local/folder ss:///bucket_name --experimental
+ response: |
+ Uploading: /path/to/folder/example1.txt => /bucket_name/folder/example1.txt
+ Uploading: /path/to/folder/example2.txt => /bucket_name/folder/example2.txt
+ Uploading: /path/to/folder/example3.txt => /bucket_name/folder/example3.txt
+ ...
+ - id: download-entire-bucket
+ name: Download bucket
+ code: supabase storage cp -r ss://bucket_name path/to/local/folder --experimental
+ response: |
+ Downloading: bucket_name/example1.txt => path/to/local/folder/bucket_name/example1.txt
+ Downloading: bucket_name/example2.txt => path/to/local/folder/bucket_name/example2.txt
+ Downloading: bucket_name/example3.txt => path/to/local/folder/bucket_name/example3.txt
+ ...
tags: []
links: []
usage: supabase storage cp <src> <dst> [flags]