David Snelling
04a33b9ae8
- Updated version to `0.10.0` in `README.md`, `cli-package/package.json`, and `src/utils/version.ts`. - Removed `CHANGELOG.md` from the root and `cli-package`, as GitHub auto-generates release notes. - Refactored `brainy-wrapper.js` to simplify utility methods (`isFloat32Array` and `isTypedArray`) by moving them to instance-level definitions. - Standardized Node.js version requirement to `>= 24.3.0` across documentation and configuration files. - Improved `textEncoding.ts` by introducing a unified `Platform` class for cross-environment compatibility (Node.js and browser). - Restructured scripts: - Replaced outdated commands (e.g., `test-cli` -> `test:cli` and `test-all` -> `test:all`) for consistency. - Removed changelog updates from `scripts/create-github-release.js` as part of simplification. - Enhanced `patch-textencoder.js` to also patch `worker.js` for both `TextEncoder` and `TextDecoder`. This release improves compatibility with Node.js 24, simplifies the deployment/changelog process, and refines text encoding and worker functionalities.
54 lines
1 KiB
Markdown
54 lines
1 KiB
Markdown
# @soulcraft/brainy-cli
|
|
|
|
Command-line interface for the [Brainy vector graph database](https://github.com/soulcraft-research/brainy).
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
# Install globally
|
|
npm install -g @soulcraft/brainy-cli
|
|
```
|
|
|
|
## Usage
|
|
|
|
Once installed, you can use the `brainy` command from anywhere:
|
|
|
|
```bash
|
|
# 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.3.0
|
|
|
|
## License
|
|
|
|
MIT
|