brainy/cli-package
David Snelling 93483572d8 **chore(scripts): prefix internal scripts with underscore for consistency**
- Updated `package.json` in `web-service-package`, `cli-package`, and the root project to prefix internal NPM scripts with an underscore (`_`), such as `_version`, `_deploy`, `_dry-run`, etc.
- Adjusted all relevant build, versioning, deployment, and test scripts to follow this convention.
- Updated `.gitignore` to include `/brainy-models-package/node_modules/` for effective exclusion.

**Purpose**: Standardize the naming of internal scripts to better differentiate them from user-facing commands and maintain consistency across packages.
2025-08-01 16:22:18 -07:00
..
src **refactor(cli): remove unnecessary @ts-expect-error for omelette import** 2025-07-22 11:06:18 -07:00
brainy-wrapper.js **refactor(cli): remove obsolete command and streamline TextEncoder/TextDecoder usage** 2025-07-15 11:52:54 -07:00
cli-wrapper.js **refactor(tests): consolidate and replace outdated environment test scripts** 2025-07-14 11:12:51 -07:00
package-lock.json **refactor(core): remove redundant dimensions property in BrainyData initialization** 2025-07-25 13:53:19 -07:00
package.json **chore(scripts): prefix internal scripts with underscore for consistency** 2025-08-01 16:22:18 -07:00
README.md **feat(tests): add tests for TextEncoder, TensorFlow.js, and fallback mechanisms** 2025-07-11 11:11:56 -07:00
rollup.config.js **feat(patch): enhance TextEncoder/TextDecoder compatibility for TensorFlow.js** 2025-07-11 12:15:11 -07:00
tsconfig.json Feat: enhance cli.ts with updated typings and improved search interface 2025-07-18 12:00:50 -07:00
types.d.ts **feat(similarity): add similarity calculation between vectors and text inputs** 2025-08-01 10:16:09 -07:00

@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