Skip to content

Add hm manual page#73

Merged
cgraf78 merged 3 commits into
mainfrom
codex/add-manpages
Jun 30, 2026
Merged

Add hm manual page#73
cgraf78 merged 3 commits into
mainfrom
codex/add-manpages

Conversation

@cgraf78

@cgraf78 cgraf78 commented Jun 30, 2026

Copy link
Copy Markdown
Owner

Add a section-1 manual page for the Hive Memory CLI and include it in release archives so packaged installs carry the same command reference as source checkouts.

Summary

  • document global options, command groups, config, files, and security boundaries
  • package man/man1/hm.1 into release tarballs
  • smoke-test that release archives include the manpage

Testing

  • bash tests/shell/release-scripts-test
  • cargo fmt --all --check
  • cargo test --locked
  • scoped checkrun format / checkrun lint on changed files
  • git diff --check

cgraf78 added 3 commits June 29, 2026 22:10
Summary
Add a section-1 manual page for the Hive Memory CLI and include it in
release archives so packaged installs carry the same command reference
as source checkouts.

- document global options, command groups, config, files, and security
  boundaries
- package `man/man1/hm.1` into release tarballs
- smoke-test that release archives include the manpage

Testing
- `bash tests/shell/release-scripts-test`
- `cargo fmt --all --check`
- `cargo test --locked`
- scoped `checkrun format` / `checkrun lint` on changed files
- `git diff --check`
Summary

Bring the `hm` manual page in line with the current command set and exit
status contract.

- describe `outbox` as flushing queued offline writes
- describe `eval` as retrieval metrics and fixture capture
- document the distinct config, privacy, and backend exit codes

Testing

- `bash tests/shell/release-scripts-test`
- `cargo fmt --all --check`
- `cargo test --locked`
- scoped `checkrun format` and `checkrun lint` for PR files
- `git diff --check`
Summary

Keep the release contract in SPEC.md aligned with the package and smoke
scripts by listing the hm manual page in the archive contents.

Testing

- tests/shell/release-scripts-test
- cargo fmt --check
- cargo test
- cargo clippy --all-targets --all-features -- -D warnings
- checkrun format SPEC.md
- checkrun lint SPEC.md
- git diff --check
@cgraf78 cgraf78 merged commit aeb6c5e into main Jun 30, 2026
15 checks passed
@cgraf78 cgraf78 deleted the codex/add-manpages branch June 30, 2026 04:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant