1.0.2 • Published 2 months ago
@spacecomx/aws-storage-uploader v1.0.2
AWS Storage Uploader
A utility for uploading files and directories to AWS S3 buckets and managing S3 objects.
Features
- Upload single files to S3
- Upload entire directories to S3 (recursively)
- List objects in S3 buckets
- Delete objects from S3 buckets
- Command-line interface for easy usage
- TypeScript support with full type definitions
- AWS SSO support
Installation
# Using npm
npm install @spacecomx/aws-storage-uploader
# Using yarn
yarn add @spacecomx/aws-storage-uploader
# Using pnpm
pnpm add @spacecomx/aws-storage-uploader
Quick Start
import { S3Uploader } from '@spacecomx/aws-storage-uploader';
// Create an uploader instance with your AWS region
const uploader = new S3Uploader('us-east-1');
// Upload a single file
await uploader.uploadFile('your-bucket-name', '/path/to/your/file.jpg');
Documentation
For detailed usage instructions and examples:
- Usage Guide - Complete API documentation with examples
- CLI Reference - Command-line interface documentation
- Contributing - Guidelines for contributors
- Development - Setup and development workflow
License
This project is licensed under the MIT License - see the LICENSE file for details.