brainy/cli-package/README.md
David Snelling eb46d816d7 **feat: improve TensorFlow.js compatibility and remove unnecessary patches**
- Removed outdated Node.js v24 compatibility patches for `TextEncoder` and `TextDecoder` in `cli-wrapper.js` and other modules since TensorFlow.js now supports Node.js v24+ natively.
- Introduced a utility module `src/utils/tensorflowUtils.ts` for TensorFlow.js compatibility, defining global `PlatformNode` and related utilities.
- Enhanced `fileSystemStorage.ts` with improved Node.js module loading mechanisms for better compatibility across environments.
- Simplified dependency requirements by reducing the minimum Node.js version to `>=23.0.0`.
- Updated `package.json`, `cli-package/package.json`, and `README.md` versions to `0.9.25`.
- Harmonized `cli-package` and main package dependencies to ensure version alignment.
- Improved global compatibility with TensorFlow.js in mixed Node.js environments.

This update modernizes TensorFlow.js integration, reduces maintenance efforts, and aligns compatibility with current Node.js and TensorFlow.js capabilities.
2025-07-02 16:16:19 -07:00

59 lines
1.2 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 >= 23.0.0
## Changelog
### 0.9.25
- Completely removed unnecessary compatibility patches for Node.js v24 as they are no longer needed with current TensorFlow.js versions
## License
MIT