Start Building
Contents
shdwDrive SDK
shdwDrive CLI
shdwDrive SDK
shdwDrive SDK is a typeScript SDK for interacting with ShdwDrive, providing simple and efficient methods for file operations on the decentralized storage platform.
Installation
Local Development
Features
📤 File uploads (supports both small and large files)
📥 File deletion
📋 File listing
📊 Bucket usage statistics
🔐 Secure message signing
⚡ Progress tracking for uploads
🔄 Multipart upload support for large files
Quick Start
Usage Examples
Upload a File
List Files
Delete a File
Get Bucket Usage
API Reference
ShdwDriveSDK
ShdwDriveSDK
Constructor Options
Methods
uploadFile(bucket: string, file: File, options?: FileUploadOptions)
deleteFile(bucket: string, fileUrl: string)
listFiles(bucket: string)
getBucketUsage(bucket: string)
shdwDrive CLI
A command-line interface for interacting with shdwDrive storage.
Features
📤 File uploads (supports both small and large files)
📥 File deletion
📋 File listing
📊 Bucket usage statistics
🔐 Secure message signing
🔄 Multipart upload support for large files
Installation
You can install the CLI globally using npm:
Or use it directly from the repository:
Configuration
The CLI uses environment variables for configuration:
SHDW_ENDPOINT
: The shdwDrive API endpoint (defaults to https://v2.shdwdrive.com)
Usage
Upload a file
Delete a file
List files in a bucket
Check bucket storage usage
Development
Clone the repository:
Install dependencies:
Build the project:
Link the CLI locally:
Last updated