Umbraco Cloud Fetch Database

0.3.0 verified Sat May 09 auth: no javascript

Wizard-based CLI that downloads a database from Umbraco Cloud and replaces the LocalDB .mdf/.ldf files in a local Umbraco ASP.NET Core project. Version 0.3.0, released as needed. Windows-only, auto-downloads sqlpackage, keeps 3 latest backups. Key differentiators: dedicated Umbraco Cloud integration, automatic sqlpackage management, backup safety.

Common errors

error Cannot find module '...' ↓

cause Node.js version <20

fix

Upgrade Node.js to >=20

error LocalDB not detected ↓

cause LocalDB is not installed or sqllocaldb.exe not in PATH

fix

Install SQL Server Express LocalDB from Microsoft

error sqlpackage: command not found ↓

cause sqlpackage not in PATH and auto-download failed

fix

Install sqlpackage manually or check internet connection

Warnings

breaking Windows-only tool will refuse to run on other operating systems. ↓

fix Use a Windows machine or Windows VM.

gotcha Requires that the project already has a working LocalDB database (the .mdf/.ldf files must exist). ↓

fix Start the Umbraco project once to let it create the database files.

gotcha sqlpackage is auto-downloaded only if not already in PATH. Use of GitHub releases may require internet access. ↓

fix Ensure internet access for automatic download or install sqlpackage manually.

gotcha Cloud database password is entered interactively and is never stored. Ensure the terminal is secure. ↓

fix Use a secure terminal and avoid screen recording.

Install

npm install umbraco-cloud-fetch-database

yarn add umbraco-cloud-fetch-database

pnpm add umbraco-cloud-fetch-database

Imports

default
wrong
```
npm install -g umbraco-cloud-fetch-database
```
correct
```
npx umbraco-cloud-fetch-database@latest
```
Use npx to run the CLI without installing globally. Global install works but is not recommended.
(package.json bin)
wrong
```
umbraco-cloud-fetch-database (without npx, if not in PATH)
```
correct
```
npx umbraco-cloud-fetch-database
```
If installed globally, the command is available as 'umbraco-cloud-fetch-database'.

Quickstart

Run the CLI inside an Umbraco web project folder to start the interactive wizard.

cd /path/to/your/umbraco/web/project
npx umbraco-cloud-fetch-database@latest