walwarden-cli

library0.0.2jsnpmunverified

Customer-side Postgres restore CLI for Walwarden, version 0.0.2. The CLI receives commands from the Walwarden dashboard and drives database restores against a target PostgreSQL instance, reporting progress and audit events back to Walwarden in real-time. It supports both new database creation and in-place destructive restore modes, with JSONL output and optional color control. Requires Node.js >= 20 and a short-lived token for authentication.

database

npm install walwarden-cli

package ↗

INSTALL

IMPORT

SIG · WALWARDEN-CLI

walwarden-cli

databasejavascriptv0.0.2

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

@walwarden/cli

✓ Run via npx: npx @walwarden/cli restore ...

This is a CLI tool, not a library. Use npx or global install. No JavaScript import.

Restore a Postgres database from a Walwarden backup using a manifest SHA-256 and target DSN.

WALWARDEN_TOKEN=abc123 WALWARDEN_API_URL=https://api.walwarden.example npx @walwarden/cli restore --manifest 0000000000000000000000000000000000000000000000000000000000000000 --target postgresql://user:password@localhost:5432/mydb --mode new_database

Debug

Known issues

gotchaThe --manifest flag expects exactly 64 hex characters. Use a different length will fail silently or with obscure error.

fix

Ensure manifest is 64 hex characters. Use sha256sum on the manifest file.

affects: >=0.0

gotchaThe --confirm-destructive flag is mandatory for in_place mode. Forgetting it will cause the command to abort without clear error.

fix

Add --confirm-destructive when using --mode in_place.

affects: >=0.0

gotchaThe WALWARDEN_API_URL environment variable is required. If missing, the CLI will fail with a generic authentication error.

fix

Set WALWARDEN_API_URL to the correct Walwarden API base URL.

affects: >=0.0

gotchaNode.js version must be >=20. Older versions will throw syntax or module errors.

fix

Update Node.js to version 20 or later.

affects: >=0.0

Errors

Common errors & fixes

Error: Manifest must be 64 hex characters

The --manifest argument is not exactly 64 hex characters.

fix

Check the manifest SHA-256 value and ensure it is 64 characters long.

Error: Destructive restore requires --confirm-destructive

Using --mode in_place without --confirm-destructive.

fix

Add --confirm-destructive to the command.

Error: WALWARDEN_API_URL environment variable not set

The required environment variable is missing.

fix

Set WALWARDEN_API_URL to your Walwarden API endpoint.

Error: The engine "node" is incompatible with this module. Expected version ">=20". Got "18.x.x"

Node.js version is below 20.

fix

Install Node.js version 20 or higher.

Upgrade

Version history

0.0.2latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

20 hits · last 30 days

node