Caryvane Help
/

Caryvane documentation

Written for the engineer with a ticket open. Every page is a task: what to do, in order, with the exact commands and the things that will trip you up called out before you hit them.

In a hurry?

Press / anywhere to search. Results point at the exact step, not just the page.

Setting Caryvane up for the first time #

The shortest path from nothing to a working, verified backup:

  1. Create a deployment token One per customer, in the console. It is what lets a machine join the right tenant. Creating deployment tokens →
  2. Install the agent on the machine Silently, with the token on the command line. Windows, macOS and Linux all supported — the command differs per platform and per installer. Deploying the agent →
  3. Add a storage target Where the data goes. You own it; Caryvane never holds a copy. Choosing and adding storage →
  4. Create the backup job Source, destination, schedule, retention. The job wizard, step by step →
  5. Prove it restores A backup you have never restored is a hypothesis, not a backup. Restoring →

Find it by task #

Deploy the agent

Silent install commands per platform, where everything lives on disk, and the prerequisites that actually bite.

Create a backup job

All six wizard steps, every option, and which options apply to which kind of source.

Restore data

The four different restore paths, what each one can and cannot do, and which to reach for.

Mount a cloud drive

Object storage as a drive letter. Platform support, cache behaviour and the real limits.

Microsoft 365 & Google

Admin consent, domain-wide delegation, what gets backed up, and the “back up everything including new users” switch.

Customers & deployment

Tenants, roles, seats, deployment tokens and per-customer storage.

Troubleshooting

Agent offline, job failing, drive not mounting — the checks in the order worth doing them.

AI assistants & API

Drive Caryvane from Claude, ChatGPT or VS Code. Every tool, every permission tier.

Conventions used here #

Three kinds of callout appear throughout, and they mean different things:

Note

Context or a shortcut. Useful, not load-bearing.

Watch out

A step people get wrong, or behaviour that surprises. Read before proceeding.

Stop

Doing this loses data, or costs money. Do not skip.

Paths are given in full. Where the product still says Aurawolf on disk — the Windows data folder, some registry keys, the .NET namespaces — that is deliberate and correct; the company renamed, the file paths did not.