From 8287e2b473c0e98612400729d8069387f54feb57 Mon Sep 17 00:00:00 2001 From: nathanwasson <126016071+nathanwasson@users.noreply.github.com> Date: Thu, 30 Oct 2025 15:29:59 -0500 Subject: [PATCH] Update explanation of default download_dir behavior. --- README.md | 2 +- mlc-r2-downloader.sh | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a9847d4..f49a9ad 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ _The metadata files are maintained in the [R2 Infra repo](https://github.com/mlc The downloader supports several options: -- `-d ` - Specify download directory (defaults to dataset name) +- `-d ` - Specify download directory (defaults to directory name within the R2 bucket for multi-file datasets, current directory for single-file datasets) - `-h` - Show help message - `-s` - Use service account credentials for authentication (requires CF_ACCESS_CLIENT_ID and CF_ACCESS_CLIENT_SECRET environment variables) - `-t` - Testing mode for running automated tests of the script with service account credentials diff --git a/mlc-r2-downloader.sh b/mlc-r2-downloader.sh index 7880a74..a9a8fe3 100644 --- a/mlc-r2-downloader.sh +++ b/mlc-r2-downloader.sh @@ -30,7 +30,8 @@ ARGUMENTS: OPTIONS: -d download-path Directory where files will be downloaded. - Defaults to the dataset name from the URL if not specified. + For single-file datasets, defaults to the current directory. + For multi-file datasets, defaults to the directory name within the R2 bucket. -s Use service-account credentials for authentication (requires CF_ACCESS_CLIENT_ID and CF_ACCESS_CLIENT_SECRET environment variables). -t Testing mode: runs reduced, non-interactive checks and always verifies