https://github.com/charlesinwald/vercel-blob-uploader

https://github.com/charlesinwald/vercel-blob-uploader

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/charlesinwald/vercel-blob-uploader
• Owner: charlesinwald
• Created: 2024-09-18T20:53:40.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-18T21:06:48.000Z (4 months ago)
• Last Synced: 2024-11-15T04:19:52.551Z (2 months ago)
• Language: JavaScript
• Size: 555 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# Vercel Blob Uploader CLI

A command-line interface (CLI) tool for uploading files or directories to Vercel Blob Storage using the [@vercel/blob](https://www.npmjs.com/package/@vercel/blob) package. This tool supports multipart uploads for large files and can be used in automation pipelines to output the resulting URLs.

## Features

- Upload single or multiple files

- Upload all files in a directory

- Supports multipart uploads for large files

- Can output only the resulting URLs (useful for pipelines)

- Uses the `BLOB_READ_WRITE_TOKEN` environment variable for authentication

## Installation

### Global Installation

Install the CLI tool globally:

`

npm install -g vercel-blob-uploader

`

### Local Installation (for development)

If you want to test the tool locally before publishing, you can use \`npm link\`:

`

npm link

`

## Usage

Once installed globally, you can run the CLI using the command \`blob-upload\`.

### Basic Usage

`

blob-upload --file ./path/to/file.txt --multipart

`

### Upload Multiple Files

You can specify multiple files to upload:

`

blob-upload --file ./file1.txt ./file2.txt --multipart

`

### Upload All Files in a Directory

To upload all files in a directory:

`

blob-upload --file ./my-directory --multipart

`

### Show Only URLs (for Pipelines)

If you only want the output to show the URLs of the uploaded files (useful for pipelines or scripts), use the \`--urls-only\` flag:

`

blob-upload --file ./file1.txt ./file2.txt --urls-only

`

### Example in a Pipeline

You can capture the output and use it in your automation pipelines:

`

file_urls=$(blob-upload --file ./file1.txt ./file2.txt --urls-only)

echo "Uploaded files are available at: $file_urls"

`

### Options

- `-f, --file `: File paths or directories to upload. You can specify multiple files or directories.

- `-p, --pathname `: The pathname to use for the upload. If not provided, it defaults to the filename.

- `--multipart`: Enable multipart uploads for large files.

- `--urls-only`: Only output the resulting URLs (useful for automation pipelines).

- `-v, --version`: Show the current version of the CLI.

## Environment Variables

The CLI requires a `BLOB_READ_WRITE_TOKEN` to be set in your environment for authentication. You can set it as follows:

`

export BLOB_READ_WRITE_TOKEN=your-vercel-token

`

Alternatively, you can pass the token in a single command:

`

BLOB_READ_WRITE_TOKEN=your-vercel-token blob-upload --file ./file.txt

`

## Development

1. Clone the repository.

2. Run `npm install` to install dependencies.

3. Use `npm link` to link the project for local testing.

4. Modify the code and test the CLI.

## License

MIT License