Repository navigation
docs: v0.24.0 release documentation - #50
phernandez wants to merge 4 commits into
Conversation
- What's New in v0.24 and Upgrade to v0.24 pages; renumber What's New - Changelog v0.24 section plus missing v0.23.1/v0.23.2 patch notes - Welcome callout points at v0.24 - MCP tools reference: POSIX read tools, revision guards, refusals as tool errors, compact/line reads, cross-project and valid-time search, metadata operators, MCP resources and the manual - CLI and configuration reference: bm cat/grep/ls/find/tail/tree, man, wiki, okf, prune, install, import document, project index/remove, status --wait, HTTP transport loopback bind, retired settings - Concepts: Markdown links as relations, locked notes, authorship, valid-time qualifiers, new Documents and PDFs page - Cloud: deprecate sync/bisync in favor of push/pull, cloud project removal always deletes cloud files, read-only API keys - Integrations: bm install, new Tau and Pi pages, Hermes/OpenClaw/Codex updates; pgvector 0.8 requirement for Postgres Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Remove the v0.23, v0.23 upgrade, Hermes plugin, Cloud app updates, agent skills, OpenClaw plugin, and AI-friendly docs pages. Old URLs redirect to the changelog or the current integration/reference page, and inbound links point at those pages or the v0.23.0 GitHub release. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7497519faa
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| - [fact] Revenue increased 14% quarter over quarter. [^document-page-2] | ||
|
|
||
| [^document-page-2]: [PDF page 2](/reports/q3-review.pdf#page=2) |
There was a problem hiding this comment.
The docs checker scans links inside fenced examples, so it treats /reports/q3-review.pdf as a required public asset. Because public/reports/q3-review.pdf does not exist, npm run check:docs fails with missing public asset /reports/q3-review.pdf, and the required .github/workflows/docs-check.yml job cannot pass. Escape or otherwise make this example non-link syntax, or update the checker to ignore fenced code.
Useful? React with 👍 / 👎.
Resolve conflicts with the v0.23 patch, video, skills, and API key changes on main: - keep the v0.24 welcome callout and changelog patch notes - keep main's API key wording (project-scoped keys are unreleased) and drop the "limit to specific projects" option; keep read-only keys - take main's Team/Invite-only access rewrite, with a v0.24 note that --visibility now works and private is refused (#1343) - drop the stale Hermes "managed install blocked" warning; the plugin has declared manifest_version 1 since Aug 28 - combine v0.23.2 folder-casing and Cloud review_mode notes with the v0.24 tool reference changes - remove the What's New pages main had edited, as on this branch Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3fb2a9f3b1
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| bm prune --dry-run | ||
| bm prune | ||
| ``` | ||
| For cloud projects, use `bm cloud prune`. |
There was a problem hiding this comment.
For a cloud project, bm cloud prune does not remove only stale index entries: it deletes every matching object from cloud storage, as documented in content/03.cloud/05.cloud-sync.md lines 276-288. A user following this immediately after the assurance that files are left untouched can therefore delete the source notes while merely trying to repair search results; keep this remedy local-only or explicitly describe the destructive cloud workflow and its dry-run/confirmation steps.
Useful? React with 👍 / 👎.
| ::note | ||
| Plain `postgres:17` does not include pgvector. Use the `pgvector/pgvector:pg17` image or run `CREATE EXTENSION IF NOT EXISTS vector;` on an existing Postgres server before Basic Memory migrates it. | ||
|
|
||
| ::note |
There was a problem hiding this comment.
This opens a second ::note while the ::note beginning on line 53 is still open at the same MDC delimiter depth. Docus nested directives require the outer container to use a longer delimiter (as the site's :::card-group/::card patterns do), so this block can render as malformed directive content rather than two callouts; close the first note before this line or promote the outer delimiter.
Useful? React with 👍 / 👎.
| | `expected_replacements` | integer | No | Default `1` | | ||
| | `replace_subsections` | boolean | No | For `replace_section`; default `true` replaces nested subsections. Set `false` to preserve them | | ||
| | `metadata` | object | No | Merge frontmatter fields independently of the body operation; provided keys overwrite or add values | | ||
| | `expected_checksum` | string | No | Apply the edit only while the note is still this revision. See [Revision guards](#revision-guards) | |
There was a problem hiding this comment.
The added row causes expected_checksum to appear twice in the same edit_note parameter table: this row calls it optional for revision guarding, while the existing row two lines later says Cloud reviewed notes require it. Readers cannot tell whether these describe separate conditions or conflicting requirements; combine them into one row that states when the parameter is optional and when Cloud requires it.
Useful? React with 👍 / 👎.
This branch has not been deployed
1 participant
Summary
Docs for the Basic Memory v0.24.0 release.
What's New
Reference
cat,grep,ls,find,tail,man) are now on by default.expected_checksum), and refused writes are returned asisError.bm cat/grep/ls/find/tail/tree,man,wiki,okf,prune,install,import document,project index.project remove,status --wait, and the HTTP transport now binds to loopback by default.semantic_search_enabled,disable_permalinks.Concepts
created_by/updated_by, and valid-time qualifiers on observations.reranker_max_document_chars: the docs said it defaults to0, but it is2000.Cloud and integrations
bm cloud sync/bisyncare deprecated in favor of push/pull.bm install, new Tau and Pi pages, and updates to the Hermes, OpenClaw, and Codex pages.Notes
v0.24.0GitHub release links won't work until the tag is published.Verification
npm run buildpasses.🤖 Generated with Claude Code