semvec/pypi-packages huggingface dataset:
unleashed-chat 0.1.4
A CLI wrapper for Unleashed.chat's chatbot service.
Requires Python: >=3.7.1

# Unleashed.chat CLI Chat Wrapper

A CLI wrapper for [Unleashed.chat](https://unleashed.chat)'s chatbot service.

> This package has no official affiliation with [Unleashed.chat](https://unleashed.chat).

## Usage

1. Install the package.
   `pip install unleashed-chat`

2. Start it up.
   `unleashed-chat`
   On the first startup, it will prompt you for your [Unleashed.chat](https://unleashed.chat) API key. Enter it to continue to the chat bot.

3. Ask the chatbot whatever you want!

## Build it yourself

1. Clone the repository.
   `git clone https://github.com/reecehunter/unleashed-chat`

2. Enter the directory.
   `cd unleashed-chat-cli`

3. Install it.
   `pip install .`

4. Use from CLI.
   `unleashed-chat`

## Commands

Once in the app, you can use the following commands instead of asking the chatbot something.

- `/help`
  - Display a list of the possible commands.
- `/reset`
  - Clear the conversation memory to start a new session.
- `/modules`
  - Display a list of the available modules.
- `/setmodule`
  - Prompts you to input the model to use.
- `/exit`
  - Exit out of the application cleanly.

## Startup Flags

- `--help, -h`
  - Display information about Unleashed Chat CLI including a description and flags.
- `--set-api-key`
  - Prompts you to enter your [Unleashed.chat](https://unleashed.chat) API key to be saved within the application.
- `--set-model`
  - Prompts you to enter the model you want to use. List available models by running the application and using the `/models` command.

## Contributing

Feel free to make a pull request on [GitHub](https://github.com/reecehunter/unleashed-chat) to add or improve on features.