Skip to content

Latest commit

 

History

History

README.md

@keeper-security/keeperapi

Keeper API client for Node.js and the browser.

Install

npm install @keeper-security/keeperapi

Local development

From the keeperapi/ directory:

npm install
npm run build
npm test

Protobuf Regeneration

Manual protobuf regeneration is not recommended. Instead, use the Update Protobuf GitHub Actions workflow, which clones the latest keeperapp-protobuf master branch and regenerates proto.js and proto.d.ts automatically.

Trigger it manually via Actions → Update Protobuf → Run workflow.

If there are changes, the workflow opens a PR from bot/update-proto. If a PR is already open, it updates the branch in place instead of creating a duplicate.

Modifying the generation script

If you need to change the protobuf generation script itself (e.g. scripts/generate-proto.mjs), push your changes to a feature branch first, then trigger the Update Protobuf workflow from that branch. This ensures the workflow runs with your updated script and the generated output reflects your changes correctly. See #199 as an example.