Skip to content

Update explanation of default download_dir behavior. #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nathanwasson merged 1 commit into from
Oct 30, 2025
Merged

Update explanation of default download_dir behavior. #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ _The metadata files are maintained in the [R2 Infra repo](https://github.com/mlc

The downloader supports several options:

- `-d <download-path>` - Specify download directory (defaults to dataset name)
- `-d <download-path>` - 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
Expand Down
3 changes: 2 additions & 1 deletion mlc-r2-downloader.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down