Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alvaroemanuel20/book-guru-cli
A NodeJS CLI App for generate book recommendations
https://github.com/alvaroemanuel20/book-guru-cli
ai books cli cli-app nodejs
Last synced: 21 days ago
JSON representation
A NodeJS CLI App for generate book recommendations
- Host: GitHub
- URL: https://github.com/alvaroemanuel20/book-guru-cli
- Owner: AlvaroEmanuel20
- Created: 2024-10-28T02:11:18.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-06T01:39:49.000Z (2 months ago)
- Last Synced: 2024-11-06T02:32:08.081Z (2 months ago)
- Topics: ai, books, cli, cli-app, nodejs
- Language: TypeScript
- Homepage:
- Size: 168 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Book Guru CLI
An app for book recommendations based on user books preferences. Get recommendation and some book offer.
## Features
- Book recommendation from OpenAI API
- Persist data with simple JSON file
- Get book offers (soon)
- Export recommendations to a CSV file
## Book preferences
- Language: book language
- Genre: book genre
- Book taste: a short text (max: 200 characters) to better customize the book recommendations
## Commands
- `preferences `: view and edit book preferences
- `view`: view all preferences
- `edit`: edit preferences
- `generate [options] `: generate new recommendations
- `limit`: limit of generations (integer)
- `-n, --new`: generate without saved preferences
- `list`: list book recommendations
- `-s, --sort `: sort by title or author
- `-g, --group `: group recommendations by genre, author or language
- `-e, --export`: export recommendations in CSV
## How to use
1 - Clone this repository:
```bash
git clone https://github.com/AlvaroEmanuel20/book-guru-cli
```
2 - Install the dependencies:
```bash
npm install
```
3 - Change `.env.example` to `.env` and fill the following variables:
```js
OPENAI_API_KEY=
OPENAI_MODEL=
DATABASE_FILE_NAME=
```
4 - Build and install cli app:
```bash
npm run build
npm install -g
```
5 - Now, you can run:
```bash
book-guru -v
book-guru preferences
```