Skip to content

mightworks/neary

 
 

Repository files navigation



Neary

An interface designed for LLM powerusers, with a feature-set to match.

Key FeaturesInstallationUser GuideGet InvolvedLicense

Key Features

  • An Interface For Powerusers

    • Open conversations in tabs
    • Organize conversations into Spaces
    • Manage conversations on the fly with slash commands
    • Embedded file manager for document search
    • App-like experience in iOS and Android through a PWA
  • A Plugin System With Tentacles 🐙

    • Deeply integrated, with full control over context
      • Snippets are bits of context inserted into every conversation
      • Tools are actions the AI can take on your behalf
    • Plugins have persistant state, removing context limitations
    • Support for third-party integrations is baked in
    • Writing new plugins is so easy gpt-3.5 can do it!
  • A Customizable Everything

    • Use the Chat Stack to organize your Snippets, Tools and Instructions into a blueprint for your conversation
    • Manage all the chat models settings at the conversation-level
    • Support for OpenAI, Azure and your own custom endpoints
    • Save your favorite configurations as Presets
    • Import and export Presets as json files

     

Installation

Docker

  1. Clone this repository

  2. Rename settings.toml.example to settings.toml

  3. Open settings.toml and add your OpenAI API key and/or custom endpoint

  4. Run docker compose up --build

  5. Point your browser to http://localhost:8000

Manual Installation

  1. Clone this repository

  2. Rename settings.toml.example to settings.toml

  3. Open settings.toml and add your OpenAI API key and/or custom endpoint

  4. Change directory to /backend

  5. Run pip install -r requirements.txt

  6. While in /backend, run python main.py

  7. Point your browser to http://localhost:8000

Upgrading

  1. Run git pull from the project root

  2. If you're using Docker, rebuild the image

  3. Restart the app

User Guide

The user guide is the best way to get acquainted with Neary. Check it out!

Get Involved

  • Write a plugin! It's fun and easy. And all contributors get one of these: 🏆. Actually, just go ahead and take one 🤲🏆. I have a lot. We'll call it a show of good faith.

  • Share your presets with the community. Preset creators were supposed to get one of these: 🏆, but prospective plugin contributors took them all.

  • Have something else in mind? Drop me line at [email protected]. But seriously, I'm out of trophies, so please don't ask.

License

Neary is free to use and open source. It operates under the GPU General Public License.

About

Get more done with LLMs

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Vue 50.8%
  • Python 37.9%
  • JavaScript 10.7%
  • Other 0.6%