krismuniz / bori

A tool for answering questions about the Web. Often comically.

bori

A tool for answering questions about the Web. Often comically.

Usage: bori [options] <query>

Arguments:
  query                       the query you want to run

Options:
  -u, --url <url>             read a specific URL
  -s, --search <engine-name>  search engine name to browse the Web (when no --url is provided) (default: "google")
  --follow-result             follow first search result in the page
  -r, --reader <reader-name>  strategy to use to browse and read web pages (default: "readability")
  -t, --temperature <number>  temperature setting for Open AI completion (default: "0")
  -m, --max-tokens <number>   max tokens setting for Open AI completion (default: "250")
  -h, --help                  display help for command

Requirements

Before you try it out, you're going to need some tools.

• git
• Node.js & npm (v19.7.0)
  • Might work with earlier versions, but this is the one I used, so I can't guarantee it will work with earlier versions.
• OpenAI API Key
• A Chrome executable that supports the new headless mode (e.g. Chrome v59+ on macOS, Chrome v60+ on Windows)
  • You can check your Chrome version by going to chrome://version in your browser.
  • You might be able to use other browsers, but I haven't tested it.

Setup

Your environment needs two environment variables:

• CHROME_PATH - the path to your Chrome executable
• OPENAI_API_TOKEN - your OpenAI API key

HINT: If you set these in the .env file in the project's root directory, the CLI will automatically load them for you! (see the .env.example file for an example)

Install and Build

# clone the repo
git clone [e-mail]:krismuniz/bori.git bori

# navigate into the project's new directory
cd bori

# install dependencies
npm install

# build the project
npm run build

# link the project
npm link

How to Use

# you can run it from anywhere (when linked)
bori "How is the weather in Ponce?"

# or
bori "Summarize in four bullet points" --url "https://krismuniz.com/about"

Run with --help to see all the options.

bori --help

How to Update

Stay in sync with my updates with git pull

# while in the project directory
git pull

# then, rebuild the project
npm run build

# and finally, link the project again
npm link

How to Uninstall

Unlink to uninstall.

# to uninstall
# while in the project directory
npm unlink .

Delete the directory from your file system. Delete it from your trash can. Disconnect your computer now!

Thank you for reading the manual!

License

The MIT License (MIT)

Copyright (c) 2023 Kristian Muñiz