aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: ad694f918cd07ac0c7e8def7c1aade3de03d80a1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# NAI
---

Néo AI, a personnal assistant using LLM.
A TUI interface for local llama.cpp LLM, in the future more functionnality will
be added to this AI.

## Usage

### Dependencies

This project is written in Rust, so you will need `rustc` and `cargo`.  
Moreover, you will need a LLM API, currently only works with local 
[llama.cpp](https://github.com/ggml-org/llama.cpp) API. 
  
### Building & Running

To build and run this project you will need to install all the dependencies used:
  
```bash
cargo install
```
  
Once that is done, just 
```bash
cargo run
``` 
and there you go !

## Screenshots

![Screenshot of the ui](screenshots/ui.png)

## TODO

- Color change if it's an user or the LLM
- Async request to the LLM API
- Start the real fun
ArKa projects. All rights to me, and your next child right arm.