Chatify

README

♫ Chatify ♫
chat-based music recommendation tool

📖 Overview

Chatify is a TUI(Terminal User Interface) tool that combines the OpenAI API with the Spotify API, allowing an AI bot to recommend the music you are looking for through conversation.

1. You can find the music you are looking for by answering questions.
2. You can listen to the music by selecting the track recommended by chatify.
3. You can store results of recommendations as playlists.

⚠️ Notice

Unfortunately, Chatify is currently not free to use; you need to have a Spotify Premium account and pay to use the OpenAI API.

👜 Prerequisites

Chatify requires two things.

1. You need to have a Spotify Premium Account to use Spotify API.
2. You need to have a OpenAI account to use OpenAI API.

💻 How to use

It is recommended that the terminal is set to full-screen size when to use Chatify.

1. Install

Homebrew Tap

brew install JunNishimura/tap/Chatify

Go install

go install github.com/JunNishimura/Chatify@latest

2. Preparation

Before saying hi to Chatify, please prepare the following three items.

1. Spotify App Client ID
2. Spotify App Client Secret
3. OpenAI API key

Spotify API

Please create any app from the Spotify for Developers Dashboard and retrieve the Client ID and Secret from the settings screen.

OpenAI API

Please create an API key from the OpenAI account screen and obtain it.

3. Greetings to Chatify

You need to provide a couple of information to Chatify at first.

$ chatify greeting

4. Talk with Chatify

Let's talk to Chatify and embark on a journey to discover new music!

$ chatify hey

⌨️ Operation

Key	Action
tab	switch the view
characters	input words
q, ctrl+c	quit
enter	answer, select
↑, ↓	move in list
←, →	turn page

🔨 Options

greeting command

-p, --port

Flag to specify the port number for Spotify authorization. Default number is 8888.

hey command

-n, --number

Flag to specify the number of recommendations. Default number is 25 and maximum number is 100.

-p, --playlist

Flag to enable chatify to make playlist based on the recommendation. Default is false.

🪧 License

Chatify is released under MIT License. See MIT

Documentation

Overview

Copyright © 2023 NAME HERE <EMAIL ADDRESS>