bm tool write-note
Create or update a markdown note.Options
--title TEXT- The title of the note (required)--folder TEXT- The folder to create the note in (required)--content TEXT- The content of the note (or pipe from stdin)--tags TEXT- Tags to apply to the note (repeatable)--project TEXT- Project to write to (default: default project)--workspace TEXT- Cloud workspace tenant ID or name--local- Force local API routing--cloud- Force cloud API routing
Examples
Output
bm tool read-note
Read a markdown note from the knowledge base.Arguments
IDENTIFIER- Note title, permalink, or memory:// URL
Options
--include-frontmatter- Include YAML frontmatter in output--page INTEGER- Page number for pagination (default: 1)--page-size INTEGER- Results per page (default: 10)--project TEXT- Project to use (default: default project)--workspace TEXT- Cloud workspace tenant ID or name--local- Force local API routing--cloud- Force cloud API routing
Examples
Output
bm tool edit-note
Edit an existing markdown note.Arguments
IDENTIFIER- Note title, permalink, or memory:// URL
Options
--operation TEXT- Edit operation: append, prepend, find_replace, replace_section (required)--content TEXT- Content for the operation (required)--find-text TEXT- Text to find (for find_replace)--section TEXT- Section heading (for replace_section)--expected-replacements INTEGER- Expected replacement count (default: 1)--project TEXT- Project to edit (default: default project)--workspace TEXT- Cloud workspace tenant ID or name--local- Force local API routing--cloud- Force cloud API routing
Examples
Output
bm tool search-notes
Search across all content in the knowledge base.Arguments
QUERY- Search query string (optional with metadata filters)
Options
--permalink- Search permalink values--title- Search title values--vector- Use vector retrieval--hybrid- Use hybrid retrieval--after_date TEXT- Results after date (e.g., ‘2d’, ‘1 week’)--tag TEXT- Filter by frontmatter tag (repeatable)--status TEXT- Filter by frontmatter status--type TEXT- Filter by frontmatter type (repeatable)--entity-type TEXT- Filter by entity, observation, relation (repeatable)--meta TEXT- Filter by key=value (repeatable)--filter TEXT- JSON metadata filter (advanced)--page INTEGER- Page number (default: 1)--page-size INTEGER- Results per page (default: 10)--project TEXT- Project to use (default: default project)--workspace TEXT- Cloud workspace tenant ID or name--local- Force local API routing--cloud- Force cloud API routing
Examples
Output
bm tool build-context
Get context needed to continue a discussion.Arguments
URL- memory:// URL or note path
Options
--depth INTEGER- Depth of context to build (default: 1)--timeframe TEXT- Timeframe filter (e.g., ‘7d’, ‘1 week’) (default: 7d)--page INTEGER- Page number (default: 1)--page-size INTEGER- Results per page (default: 10)--max-related INTEGER- Maximum related items (default: 10)--project TEXT- Project to use (default: default project)--workspace TEXT- Cloud workspace tenant ID or name--local- Force local API routing--cloud- Force cloud API routing
Examples
Output
bm tool recent-activity
Get recent activity across the knowledge base.Options
--type TEXT- Filter by item type (repeatable)--depth INTEGER- Depth of context (default: 1)--timeframe TEXT- Timeframe filter (default: 7d)--page INTEGER- Page number (default: 1)--page-size INTEGER- Results per page (default: 50)--project TEXT- Project to use (default: default project)--workspace TEXT- Cloud workspace tenant ID or name--local- Force local API routing--cloud- Force cloud API routing
Examples
Output
bm tool list-projects
List all available projects.Options
--local- Force local API routing--cloud- Force cloud API routing
Examples
Output
bm tool list-workspaces
List available cloud workspaces.Options
--local- Force local API routing--cloud- Force cloud API routing
Examples
Output
Schema Commands
bm tool schema-validate
Validate notes against their schemas.Arguments
TARGET- Note path or note type to validate (optional)
Options
--project TEXT- Project to use (default: default project)--workspace TEXT- Cloud workspace tenant ID or name--local- Force local API routing--cloud- Force cloud API routing
Examples
Output
bm tool schema-infer
Infer schema from existing notes of a type.Arguments
NOTE_TYPE- Note type to analyze (e.g., person, meeting)
Options
--threshold FLOAT- Minimum frequency for optional fields 0-1 (default: 0.25)--project TEXT- Project to use (default: default project)--workspace TEXT- Cloud workspace tenant ID or name--local- Force local API routing--cloud- Force cloud API routing
Examples
Output
bm tool schema-diff
Show drift between schema and actual usage.Arguments
NOTE_TYPE- Note type to check for drift
Options
--project TEXT- Project to use (default: default project)--workspace TEXT- Cloud workspace tenant ID or name--local- Force local API routing--cloud- Force cloud API routing
Examples
Output
JSON Output
All tool commands output JSON for easy parsing:Routing Options
Most tool commands support routing flags:--local- Force local API routing--cloud- Force cloud API routing--project TEXT- Specify project--workspace TEXT- Specify cloud workspace
Error Handling
Errors are returned in JSON format:0- Success1- Error occurred