Quick Start

Get CloudSync running in under 5 minutes with this quick start guide.

Install

npm

npm install -g @cloudsync/cli

yarn

yarn global add @cloudsync/cli

pnpm

pnpm add -g @cloudsync/cli

Login

cloudsync login

This opens your browser to authenticate with CloudSync.

Create a Workspace

cloudsync init my-project
cd my-project

Start Syncing

cloudsync sync

That's it! Your files are now syncing to the cloud.

SDK Quick Start

For programmatic access, install our SDK:

npm install @cloudsync/sdk

import { CloudSync } from '@cloudsync/sdk'

const client = new CloudSync({
  apiKey: process.env.CLOUDSYNC_API_KEY
})

// Upload a file
await client.files.upload({
  workspace: 'my-project',
  path: '/documents/report.pdf',
  file: fileBuffer
})

// List files
const files = await client.files.list({
  workspace: 'my-project',
  path: '/documents'
})

console.log(files)

What's Next?

• Full Getting Started Guide
• API Reference
• Webhook Integration