🦊 Kitsune CLI

A mystical, fox-spirit themed command-line interface companion.

---

Kitsune CLI (kit) is a beautifully crafted, terminal-based companion. Channeling the ancient wisdom of the Kitsune (fox spirit), this CLI tool provides mystical advice, speaks to you directly through your terminal, and offers a visually stunning experience using gradients, beautiful boxes, and terminal animations.

Features

• 🦊 Mystical Aesthetic: Beautiful terminal styling using chalk, gradient-string, and boxen.
• 🗣️ Auditory Responses: The spirit actually speaks to you using the say package.
• 🧘‍♂️ Wisdom & Quotes: Summons random wisdom and philosophical quotes via the API Ninjas service.
• 🛠️ Modular Architecture: Built with TypeScript and Node.js using commander.

Installation

Ensure you have Node.js installed, then follow these steps:

1. Clone the repository:

   git clone https://github.com/bhavish-codes/Kitsune-cli.git
   cd Kitsune-cli

2. Install dependencies:

   npm install

3. Set up your environment variables: Create a .env file in the root directory and add your API Ninjas Key:

   API_NINJAS_KEY=your_api_key_here

4. Build the TypeScript files:

   npx tsc

5. Link the package globally:

   npm link

Now you can summon the spirit from anywhere using the kit command!

Usage & Commands

Here are the currently active incantations you can use:

1. Speak

Have the Kitsune channel ancient wisdom and speak your words aloud.

kit speak "Hello traveler, welcome to my realm."

2. Spirit

Summon the Kitsune spirit to receive a piece of wisdom, philosophy, or truth. Optionally, have the spirit speak the quote out loud.

kit spirit
# Or to hear the spirit speak:
kit spirit speak

3. Help

Summon the mystical help menu for detailed information about a specific command.

kit help speak

4. Loud

Make the Kitsune shout your message across the digital realm, using large text.

kit loud "Wake up!"
# Or to hear the spirit speak loud:
kit loud "Wake up!" speak

5. Riddle

The cunning fox presents a puzzle for your mind. You can provide a timer in seconds.

kit riddle 30

6. Joke

A touch of kitsune mischief. Summon the fox to tell you a witty joke.

kit joke
# Or to hear the spirit speak the joke:
kit joke speak

7. Weather

Read the winds and skies. The spirit will consult the atmosphere to divine your local conditions or any specified location.

kit weather
# For a specific location:
kit weather tokyo
# To hear the forecast aloud:
kit weather london speak

8. Wordel

The cunning fox tests your vocabulary with a game of Wordel. You have 6 tries to guess a mystery word. You can optionally specify the word length.

kit wordel
# For a specific word length between 3 and 8:
kit wordel 6

---

Built With

• TypeScript - For robust, strongly-typed code.
• Commander.js - The complete solution for node.js command-line interfaces.
• Chalk & Gradient-String - For beautiful terminal styling.
• Boxen - For creating terminal boxes.
• Ora - Elegant terminal spinners.
• Say - TTS (Text To Speech) wrapper.

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page if you want to contribute.

License

This project is licensed under the ISC License.