Command Line Interface (CLI)
Manage your cloud files and transfers directly from your terminal with the MigrateClouds CLI.
CLI availability
The CLI is available on all plans. Advanced features are available on Pro and Enterprise plans. See our pricing page for more details.
Installation
You can install the MigrateClouds CLI using npm, yarn, or download the binary directly.
Using npm
npm install -g migrateclouds-cli
Using yarn
yarn global add migrateclouds-cli
Direct download
You can download the binary for your platform from our GitHub releases page.
Authentication
Before using the CLI, you need to authenticate with your MigrateClouds account:
migrateclouds login
This will open a browser window where you can log in to your MigrateClouds account. Alternatively, you can authenticate using an API key:
migrateclouds login --key YOUR_API_KEY
You can generate an API key in your MigrateClouds dashboard under Settings → API Keys.
Basic Commands
Command | Description |
---|---|
migrateclouds --help | Display help information |
migrateclouds --version | Display the CLI version |
migrateclouds login | Authenticate with your MigrateClouds account |
migrateclouds logout | Log out from your MigrateClouds account |
migrateclouds services list | List connected cloud services |
migrateclouds services connect | Connect a new cloud service |
File Operations
Command | Description |
---|---|
migrateclouds ls [service]:[path] | List files in a directory |
migrateclouds cp [source] [destination] | Copy files between services or directories |
migrateclouds rm [service]:[path] | Delete files or directories |
migrateclouds mkdir [service]:[path] | Create a new directory |
migrateclouds download [service]:[path] [local-path] | Download files to your local machine |
migrateclouds upload [local-path] [service]:[path] | Upload files from your local machine |
Transfer Operations
Command | Description |
---|---|
migrateclouds transfers list | List recent transfers |
migrateclouds transfers status [transfer-id] | Check the status of a transfer |
migrateclouds transfers cancel [transfer-id] | Cancel an in-progress transfer |
Examples
List files in Google Drive
migrateclouds ls google:/Documents
Copy a file from Google Drive to Dropbox
migrateclouds cp google:/Documents/report.pdf dropbox:/Backup/report.pdf
Download a file from OneDrive
migrateclouds download onedrive:/Photos/vacation.jpg ./Downloads/
Upload a file to Dropbox
migrateclouds upload ./Documents/presentation.pptx dropbox:/Work/
Create a new folder in Google Drive
migrateclouds mkdir google:/Projects/NewProject
Advanced Usage
Using configuration files
You can create a configuration file to store common settings and options. Create a file named .migratecloudsrc
in your home directory:
{ "default_service": "google", "output_format": "json", "timeout": 300, "concurrent_transfers": 5 }
Scripting and automation
The CLI can be used in scripts and automated workflows. Use the --json
flag to get machine-readable output:
migrateclouds ls google:/Documents --json > documents.json
Environment variables
You can use environment variables to configure the CLI:
MIGRATECLOUDS_API_KEY
: Your API keyMIGRATECLOUDS_OUTPUT_FORMAT
: Output format (json, table, text)MIGRATECLOUDS_TIMEOUT
: Request timeout in seconds
Need help?
For more information, run migrateclouds --help
or visit our API reference