Sync S3 or local directory using CLI

Use CLI to keep your local directory or S3 bucket synced with Akord vault.

Using CLI sync feature you can sync "storages" interchangeably. Supported storage types are: local file system, S3 bucket and Akord vault.

Most common usecase is to push your local directory to Akord permanent storage vault. But you may mix source and destination as preferred. E.g. you can sync two directories on your local disk, two s3 buckets. You can download all files from Akord vault, keeping the folder structure into your local file system by syncing vault with local directory. Sync of two Akord vaults can also be helpful - you may prepare your vault in cloud storage, version the files and delete not needed ones as you go. When in final state, sync two vaults by providing the cloud vault as source and permanent storage vault as destination.

1. Install the CLI

npm i -g @akord/akord-cli

2. Sign up to Akord

You can create your account in seconds using browser app or test your CLI installation by making 'signup' your first command typed in CLI:

akord signup {you_email_address}

3. Create a Permanent & Public vault

You may want to stick with CLI only:

akord vault:create 'shiny vault'

or use a browser app:

Press V as a shortcut to create a vault or click the "Create vault" button to setup your vault. Choose Permanent and Public:

4. Sync your local directory with Akord vault

akord sync some/path/to/files akord://vault_id

Some additional options you may find useful when using sync

  • skip approval step (-a, --auto-approve): akord sync some/path/to/files akord://vault_id --auto-approve

  • non recursive (-r, --recursive): akord sync some/path/to/files akord://vault_id --recursive=false

  • include hidden files and folders (--h, --include-hidden): akord sync some/path/to/files akord://vault_id --include-hidden

  • delete files from target storage that do not exist in source storage (-d, --delete): akord sync some/path/to/files akord://vault_id --delete

Last updated