Welcome to Skyplane!

Skyplane is an secure, open-source tool for blazingly fast data transfers cloud object stores.

Note

This project is under active development.

skyplane cp copies files from one cloud provider to another

Skyplane’s cp command supports copying large datasets between cloud regions within a single provider:

$ skyplane [sync/cp] [local/s3/gcp/azure]://mybucket/big_dataset [local/s3/gcp/azure]://mybucket2/

Contents

Overview

• Getting Started
  • Installation
  • Cloud Credentials
  • Transferring Data
• Configuration
  • Increasing performance of transfers via paralllelism
  • Reusing Gateways
  • Configuring networking between gateways
• Architecture
  • Transfer Integrity and Checksumming
  • Security
  • Encryption
  • Firewalls
  • Large Objects
• FAQ
  • I get InsufficientVCPUException when running a transfer
  • Does Skyplane support local transfers?
  • How does Skyplane map object keys from source to destination?
  • I am unable to copy files to a folder in my destination bucket due to a Missing Object Error

Developer documentation

• Building from source
  • Setting up a developer environment
  • Building and testing Skyplane
    • Building and pushing a Skyplane Docker image
      • First time setup: make sure ghcr image is “public”
    • Building the Skyplane client
    • Testing a transfer
  • Development Tips
• Contributing to Skyplane
  • Ways to Contribute
  • Code Contributions
    • Submitting pull requests
• Roadmap
  • Skyplane 0.1.0 release (current)
  • Skyplane 0.2.0 release
  • Upcoming
• Debugging Tools
  • Logs
    • Client Logs
    • Gateway Logs
    • Chunk API
  • Gateway ssh

Package documentation

• CLI documentation
  • skyplane
• Internal CLI documentation
  • skyplane
• Internal package documentation
  • skyplane.replicate.replicator_client module
  • skyplane.chunk module
  • skyplane.config module
  • skyplane.exceptions module

Community

• Slack