CLI Chan - A Kawaii Copilot for Your CLI

CLI Chan is here to assist you in your command-line journey. She's powered by OpenAI and a dash of humor, so buckle up and get ready for some fun with your new kawaii CLI copilot!

Table of Contents

• Features
• Installation
• Usage
• Contributing
• License

Features

• Global Commands - Chat with CLI Chan directly from your terminal
• Context/Long Term Memory - Supports conversation context & long-term memory
• System Awareness - CLI Chan checks some info about your OS & the directories to provide you with the best possible answers
• Unlimited Usage - No limit on the number of conversations

Installation

$ npm install -g cli-chan

or if you prefer yarn

$ yarn add --global cli-chan

Usage

Configuration

Set the OpenAI API key:

cc config -k YOUR_API_KEY

Ask CLI Chan a question

cc ask Can you remind me how I can delete all folders recursively?

Get Executable commands from CLI Chan

cc cmd Give me a command to get the free and total memory of the system.

Contributing

• Fork the project.
• Create a feature branch (git checkout -b feature/YourFeature).
• Commit your changes (git commit -m 'Add YourFeature').
• Push to the branch (git push origin feature/YourFeature).
• Open a pull request.
• Please add a little bit of humor to your contributions. CLI Chan is all about making the CLI experience more enjoyable!

License

CLI Chan is available under the MIT License. So feel free to share your happiness and humor with the world!