norch

      ___           ___           ___           ___           ___      
     /\__\         /\  \         /\  \         /\  \         /\__\     
    /::|  |       /::\  \       /::\  \       /::\  \       /:/  /     
   /:|:|  |      /:/\:\  \     /:/\:\  \     /:/\:\  \     /:/__/      
  /:/|:|  |__   /:/  \:\  \   /::\~\:\  \   /:/  \:\  \   /::\  \ ___  
 /:/ |:| /\__\ /:/__/ \:\__\ /:/\:\ \:\__\ /:/__/ \:\__\ /:/\:\  /\__\ 
 \/__|:|/:/  / \:\  \ /:/  / \/_|::\/:/  / \:\  \  \/__/ \/__\:\/:/  / 
     |:/:/  /   \:\  /:/  /     |:|::/  /   \:\  \            \::/  /  
     |::/  /     \:\/:/  /      |:|\/__/     \:\  \           /:/  /   
     /:/  /       \::/  /       |:|  |        \:\__\         /:/  /    
     \/__/         \/__/         \|__|         \/__/         \/__/     

Installation and usage

Terminal

To install and invoke from the terminal type npx norch.

The following options are available

  -V, --version                  output the version number
  -c, --configFile <configFile>  specify a configuration file
  -n, --name <name>              specify the name/location of the index (default: "norch-data")
  -p, --port <port>              specify the port (default: 3030)
  -h, --help                     display help for command

Node

To include norch in an existing node project, use npm i norch. Norch can then be invoked from within a node application like so:

import { Norch } from 'norch'

const myNorch = new Norch(ops) // same options as terminal

API

Checkout the OpenAPI documentation online, or at /api.html on your own norch server.