README.md

Keeper Javascript SDK

This repository contains npm packages for interacting with the Keeper backend from JavaScript or TypeScript.

Package	Purpose
@keeper-security/keeper-sdk-javascript	High-level API + Commander-style in-process CLI (dispatchCliLine)
@keeper-security/keeperapi	Low-level REST/protobuf client (direct use not recommended)

Repository layout

keeper-sdk-javascript/
├── KeeperSdk/              # @keeper-security/keeper-sdk-javascript
├── keeperapi/              # @keeper-security/keeperapi
└── examples/
    ├── sdk_example/        # Runnable Node scripts (auth, records, folders, …)
    └── repl/               # Interactive vault shell (see examples/repl/README.md)

Start here for CLI / vault behavior: KeeperSdk/README.md — built-in commands, get / whoami output, and KeeperCliHost adapter requirements.

Browser embedders (e.g. @keeper-security/keeper-shell-component) consume this repo via npm or a local path. Fix CLI formatting and vault surface issues in KeeperSdk first, then rebuild the shell against the updated SDK.

Quick development

Build keeperapi before KeeperSdk (SDK depends on keeperapi):

cd keeperapi && npm install && npm run build
cd ../KeeperSdk && npm install && npm run link-local && npm run build

• Node entry: KeeperSdk/dist/index.js
• Browser entry: KeeperSdk/dist/browser.js (via src/browser.ts — no Node readline / console auth)

Run SDK examples:

cd examples/sdk_example && npm install
npm run auth:restore-session -- --from-json /path/to/session.json
npm run records:list:shell-cli -- --from-json /path/to/session.json

Or jump into the interactive vault REPL (needs KeeperSdk linked via npm run link-local above):

cd examples/repl && npm install
npm start

See examples/repl/README.md for the command list.

Package docs

• KeeperSdk/README.md — API, CLI commands, host adapter
• keeperapi/README.md — core client

Contributing

To ignore formatting-only commits in git blame:

git config blame.ignoreRevsFile .git-blame-ignore-revs