Giter Club home page Giter Club logo

chatd's Introduction

chatd.mp4

Chat with your documents using local AI. All your data stays on your computer and is never sent to the cloud. Chatd is a completely private and secure way to interact with your documents.

Chatd is a desktop application that lets you use a local large language model (Mistral-7B) to chat with your documents. What makes chatd different from other "chat with local documents" apps is that it comes with the local LLM runner packaged in. This means that you don't need to install anything else to use chatd, just run the executable.

Chatd uses Ollama to run the LLM. Ollama is an LLM server that provides a cross-platform LLM runner API. If you already have an Ollama instance running locally, chatd will automatically use it. Otherwise, chatd will start an Ollama server for you and manage its lifecycle.

Quickstart

  1. Download the latest release from chatd.ai or the releases page.
  2. Unzip the downloaded file.
  3. Run the chatd executable.

Advanced Setup

Links

Development

Run the following commands in the root directory.

npm install
npm run start

Packaging and Distribution

MacOS

  1. Download the latest ollama-darwin release for MacOS from here.
  2. Make the downloaded binary executable: chmod +x path/to/ollama-darwin
  3. Copy the ollama-darwin executable to the chatd/src/service/ollama/runners directory.
  4. Optional: The Electron app needs be signed to be able to run on MacOS systems other than the one it was compiled on, so you need a developer certificate. To sign the app, set the following environment variables:
[email protected]
APPLE_IDENTITY="Developer ID Application: Your Name (ABCDEF1234)"
APPLE_ID_PASSWORD=your_apple_id_app_specific_password
APPLE_TEAM_ID=ABCDEF1234

You can find your Apple ID, Apple Team ID, and Apple ID Application in your Apple Developer account. You can create an app-specific password here.

  1. Run npm run package to package the app.

Windows

  1. Build Ollama from source for Windows, this will support CPU only. See here.
  2. Copy the ollama.exe executable to chatd/src/service/ollama/runners/ollama.exe.
  3. Run npm run package to package the app.

Note: The Windows app is not signed, so you will get a warning when you run it.

Linux

  1. Build Ollama from source for Linux x64 to support CPU only, this allows for a smaller executable package. See here.
  2. Copy the ollama executable to chatd/src/service/ollama/runners/ollama-linux.
  3. Run npm run package to package the app.

chatd's People

Contributors

brucemacd avatar nonno-cicala avatar micheleriva avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.