- Introduced `SearchResult` interface to standardize search result handling and improve code readability. - Added TypeScript type annotations for command arguments and options in CLI methods to enforce stricter type safety. - Updated `.version()` for CLI to align with best practices by removing redundant description parameter. - Enhanced search logic with default parameter handling for limits and improved output formatting for results. - Adjusted `tsconfig.json` to disable `noImplicitAny` while retaining strict typing practices. - Streamlined CLI processes by parsing command-line arguments explicitly with `program.parse(process.argv)`. Purpose: Improve developer productivity with better type safety, clearer interfaces, and refined CLI functionality. |
||
|---|---|---|
| .. | ||
| src | ||
| brainy-wrapper.js | ||
| cli-wrapper.js | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| rollup.config.js | ||
| tsconfig.json | ||
| types.d.ts | ||
@soulcraft/brainy-cli
Command-line interface for the Brainy vector graph database.
Installation
# Install globally
npm install -g @soulcraft/brainy-cli
Usage
Once installed, you can use the brainy command from anywhere:
# Show help
brainy --help
# Initialize a new database
brainy init
# Add data
brainy add "Cats are independent pets" '{"noun":"Thing","category":"animal"}'
# Search
brainy search "feline pets" --limit 5
# Add relationships
brainy addVerb id1 id2 RelatedTo '{"description":"Both are pets"}'
# Visualize the graph
brainy visualize
brainy visualize --root <id> --depth 3
# Generate random test data
brainy generate-random-graph --noun-count 20 --verb-count 30 --clear
Features
- Full access to all Brainy database functionality from the command line
- Autocomplete support for commands and options
- Visualization of graph data
- Import/export capabilities
- Augmentation pipeline testing
Requirements
- Node.js >= 24.4.0
License
MIT