initial implementation of vault cli

KeeperSdk/README.md

@@ -1,6 +1,8 @@
 # @keeper-security/keeper-sdk-javascript
 
-Keeper Javascript SDK for Node.js.
+Keeper JavaScript SDK for **Node** and **browser** — vault API, sharing, folders, and enterprise admin APIs.
+
+> **CLI:** Commander-style shell commands (`dispatchCliLine`, `help`, `get`, `ls`, …) live in [**@keeper-security/keeper-shell-component**](https://www.npmjs.com/package/@keeper-security/keeper-shell-component) (or this monorepo’s `commander-javascript-cli` package). This SDK package is API-only.
 
 [![NPM](https://img.shields.io/npm/v/@keeper-security/keeper-sdk-javascript?style=for-the-badge&logo=npm&logoColor=white)](https://www.npmjs.com/package/@keeper-security/keeper-sdk-javascript)
 
@@ -10,57 +12,78 @@ Keeper Javascript SDK for Node.js.
 npm install @keeper-security/keeper-sdk-javascript
 ```
 
-## Quickstart
+## Entry points
+
+| Environment | Import                                                     | Notes                                                         |
+| ----------- | ---------------------------------------------------------- | ------------------------------------------------------------- |
+| Node        | `@keeper-security/keeper-sdk-javascript` → `dist/index.js` | `ConsoleAuthUI`, `FileConfigLoader`, full auth                |
+| Browser     | same package → `dist/browser.js`                           | Platform shim only; use in-memory session + `restore-session` |
+
+## Quickstart (Node)
 
 ```typescript
-import { KeeperVault, ConsoleAuthUI, FileConfigLoader } from '@keeper-security/keeper-sdk-javascript'
+import {
+  KeeperVault,
+  ConsoleAuthUI,
+  FileConfigLoader,
+} from "@keeper-security/keeper-sdk-javascript";
 
 const vault = new KeeperVault({
-    authUI: new ConsoleAuthUI(),
-    configLoader: new FileConfigLoader('./keeper-config.json'),
-})
+  authUI: new ConsoleAuthUI(),
+  sessionStorage: new FileConfigLoader("./keeper-config.json"),
+});
 
-await vault.login()
-await vault.syncDown()
+await vault.login("[email protected]", "password");
+await vault.sync();
 
-console.log(`Loaded ${vault.records.size} records`)
+console.log(`Loaded ${vault.getRecords().length} records`);
 ```
 
 ## Supported functionality
 
-`KeeperVault` exposes the operations below. Enterprise features require an enterprise administrator account.
+`KeeperVault` exposes vault operations. Enterprise features require an enterprise administrator account.
 
 - **Authentication**: Login, session token login, resume session, sync, logout
 - **Records**: List, search, add, update, delete, move, history
 - **Folders**: List, get, create, rename, delete, change directory, folder tree
 - **Shared folders**: List shared folders, share with users, update permissions
 - **Sharing**: Share and unshare records, check share info
-- **Teams**: List, view, add, update, delete teams
-- **Users**: List, view, add, update, delete users; lock/unlock accounts; expire passwords; manage aliases and team membership
-
-Enterprise features need an enterprise administrator account.
+- **Teams / users / roles** (enterprise admin): Available via the SDK API
 
 ## Examples
 
-Runnable scripts for the areas above are in [`examples/sdk_example`](../examples/sdk_example):
+Shell CLI (`dispatchCliLine`, categorized `help`, record/folder commands) is provided by **@keeper-security/keeper-shell-component** — see that package’s `src/keeper-cli/README.md`.
+
+Runnable SDK scripts are in [`examples/sdk_example`](../examples/sdk_example):
 
 ```bash
 cd examples/sdk_example
 npm install
 npm run auth:login
 npm run records:list
+npm run records:get        # interactive; similar to CLI get + share info
 npm run folders:ls
 npm run shared-folders:list-sf
-npm run teams:list
-npm run users:list
+```
+
+Shell CLI parity (same dispatch path as the vault shell):
+
+```bash
+npm run records:list:shell-cli -- --from-json /path/to/session.json
 ```
 
 ## Local development
 
-From the `KeeperSdk/` directory:
+From repo root, build keeperapi first:
 
 ```bash
-npm install
-npm run link-local
-npm run build
+cd keeperapi && npm install && npm run build
+cd ../KeeperSdk && npm install && npm run link-local && npm run build
 ```
+
+Watch types: `npm run types` (in `KeeperSdk/`).
+
+## Related
+
+- [`keeperapi/README.md`](../keeperapi/README.md) — core client
+- [`../README.md`](../README.md) — monorepo overview