27 lines (20 loc) · 1.24 KB

AGENTS.md — @barekey/cli

Package Manager

This repo uses Bun.
Use bun install for dependency changes.
Use bun run <script> for project scripts.
Use bun test for tests.
Do not use npm or commit package-lock.json.

Releases

CLI update ritual

If CLI work changes the shipped CLI behavior, commands, output, flags, package exports, or published artifacts, bump the CLI version before merging to master.
Keep CLI versions aligned in both package.json and src/constants.ts.
Use semantic versioning for the CLI bump: patch for backward-compatible fixes, minor for backward-compatible features, major for breaking changes.
If the CLI depends on a newly released SDK feature or fix, update @barekey/sdk in package.json, run bun install, and commit the resulting bun.lock changes too.
Before pushing, run:
- bun test test
- bun run typecheck
- bun run build

SDK handoff from CLI

If work includes merging changes to /home/sander/barekey/sdk, make sure the SDK repo is version-bumped first whenever its surface, generated types, runtime behavior, or published artifacts changed.
After that SDK merge, update the CLI dependency to the new SDK version if the CLI consumes the changed behavior.