stash

library0.10.1jsnpmunverified

CipherStash CLI (v0.10.1) — single command for authentication, project initialization, EQL database lifecycle (install, upgrade, validate, push, migrate), encryption schema building, and secrets management. Requires Node >=22 and peer dependency @cipherstash/stack >=0.6.0. Ships TypeScript types. Differentiators: unified CLI replacing separate tools, auto-detects and scaffolds stash.config.ts, supports Supabase and Drizzle providers. Release cadence: minor updates monthly.

devops database auth-security

npm install stash

package ↗homepage ↗

INSTALL

IMPORT

SIG · STASH

stash

devopsjavascriptv0.10.1

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.

defineConfig

✓ import { defineConfig } from '@cipherstash/cli'

✗ const { defineConfig } = require('@cipherstash/cli')

ESM-only package since v0.10.0. CommonJS require() will fail.

default import

✓ import cli from '@cipherstash/cli'

✗ const cli = require('@cipherstash/cli')

Default export is not documented; prefer named imports like defineConfig.

StashConfig type

✓ import type { StashConfig } from '@cipherstash/cli'

Type import for TypeScript projects.

Install CLI, authenticate, scaffold encryption client and schema, install EQL extensions.

npm install -D @cipherstash/cli npx @cipherstash/cli auth login npx @cipherstash/cli init npx @cipherstash/cli db install

stash --version

Debug

Known issues

breakingPackage is ESM-only since v0.10.0. CommonJS require() will throw ERR_REQUIRE_ESM.

fix

Use import statements and set "type": "module" in package.json.

affects: >=0.10.0

deprecatedThe --supabase and --drizzle flags may be deprecated in future releases in favor of auto-detection.

fix

Check documentation for current recommended approach.

affects: <1.0.0

gotchaThe CLI reads .env files automatically but does not override existing environment variables. This can cause confusion if you expect .env to override.

fix

Ensure .env values are set correctly and not shadowed by shell environment.

affects: >=0.10.0

gotchaThe auth token is saved to ~/.cipherstash/auth.json in plaintext. Ensure file permissions are restrictive.

fix

Set umask or chmod 600 on the file after login.

affects: >=0.10.0

Errors

Common errors & fixes

ERR_REQUIRE_ESM

Using require() on an ESM-only package.

fix

Replace const x = require('@cipherstash/cli') with import { defineConfig } from '@cipherstash/cli' and ensure "type": "module" in package.json.

Error: Cannot find module '@cipherstash/stack'

Missing peer dependency @cipherstash/stack.

fix

Run npm install @cipherstash/stack to install the peer dependency.

Error: stash.config.ts not found

Cannot find the configuration file. CLI walks up directories from CWD.

fix

Run npx @cipherstash/cli db install first to scaffold the config, or create stash.config.ts manually with defineConfig.

Error: The `databaseUrl` option is required

Missing databaseUrl in stash.config.ts or environment variable.

fix

Set DATABASE_URL in .env or define databaseUrl in your stash.config.ts.

Upgrade

Version history

0.10.1latest on npm

Audit

Dependencies

@cipherstash/stackrequiredRuntime SDK peer dependency required for encryption operations

Agent activity

19 hits · last 30 days

node