Registry / devops / axiomdb-cli

axiomdb-cli

JSON →
library0.1.10jsnpmunverified

AxiomDB CLI (v0.1.10) is a command-line tool for managing multi-branch PostgreSQL databases on the AxiomDB platform. It provides fast terminal control for projects, branches, Prisma connection URLs, network access, metrics, backups, audit logs, and secrets. Uses OAuth 2.0 with PKCE for authentication via Square IdP. Exposes the 'axm' command for speed while keeping 'axiom' for backward compatibility. Key differentiator: native Prisma URL generation for branch databases. Release cadence is irregular as the package is in early development (0.x).

devops
npm install axiomdb-cli
github ↗package ↗homepage ↗
INSTALL
IMPORT
SIG · AXIOMDB-CLI
A
axiomdb-cli
devopsjavascriptv0.1.10
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.

axm
✓ npm install -g axiomdb-cli
✗ npm install axiomdb-cli (missing -g for global install)
The CLI is meant to be used globally; local installs won't resolve the 'axm' command without npx.
axiom
✓ axiom login
✗ axm login (though 'axm' is the new name, 'axiom' still works for compatibility)
'axiom' command is deprecated as of v0.1.0 but kept for backward compatibility. Use 'axm' for new scripts.
axm -li
✓ axm -li (short for login)
✗ axm -l (ambiguous, may not exist)
Abbreviated flags like -li (login) are specific; check help for exact shorthand mappings.

Installs the CLI globally, authenticates via OAuth, creates a short-lived branch, and retrieves Prisma-ready database URLs.

npm install -g axiomdb-cli axm login # Opens browser for OAuth, then paste code axm projects list axm projects use "My Project" axm branches create --name test-branch --lifespan 7d axm branches urls --name test-branch # Output: DATABASE_URL postgresql://...
Debug
Known issues
breakingCommand 'axiom' renamed to 'axm' for performance; 'axiom' still works but is deprecated.
fix
Use 'axm' instead of 'axiom' in scripts and CI pipelines.
affects: >=0.1.0
deprecatedFlag short forms like -pr, -br are experimental and may change in future releases.
fix
Use long-form flags (e.g., --projects, --branches) for stability.
affects: <1.0.0
gotchaGlobal install required: 'npm install -g axiomdb-cli' not just 'npm install axiomdb-cli'.
fix
Re-run with -g flag, then use npx or add node_modules/.bin to PATH if local install is desired.
affects: all
gotchaOAuth loopback may fail on headless servers; manual code paste is required.
fix
Pass --no-browser to get a URL to open manually, then paste the authorization code back.
affects: all
Errors
Common errors & fixes
Command not found: axm
Global install not performed or not in PATH.
fix
Run 'npm install -g axiomdb-cli' and ensure npm global bin is in PATH.
Error: Cannot find module 'axiomdb-client'
Missing dependency, possibly due to incomplete install or corrupted node_modules.
fix
Reinstall with 'npm install -g axiomdb-cli' or check that node_modules contains axiomdb-client.
AxmError: OAuth token expired or invalid
Session timeout or manual logout.
fix
Run 'axm login' to re-authenticate.
Bad flag: -pr
Unknown shorthand flag (maybe typo or version mismatch).
fix
Use long form: --projects for the command, or run 'axm --help' for correct flags.
Upgrade
Version history
0.1.10latest on npm
Audit
Dependencies
axiomdb-clientrequiredAPI client for AxiomDB backend operations
commanderrequiredCLI command parsing and routing
openrequiredOpens browser for OAuth login flow
Agent activity
8 hits · last 30 days
node
6
OpenAI (training)
1
Resources
githubhttps://github.com/squareexp/axiomdb-cli ↗
packageaxiomdb-cli ↗
homepagehttps://github.com/squareexp/axiomdb-cli ↗
axiomdb-cli — npm install axiomdb-cli · libregistry