igris-soul 1.1.2 → 1.1.4

package/README.md

@@ -1,172 +1,149 @@
-# Igris Soul
+# ⚔️ Igris Soul
 
-> Your personal AI assistant in the terminal, inspired by Igris from Solo Leveling.
->
-> Install it globally and summon Igris from anywhere:
->
-> ```bash
-> npm install -g igris-soul
-> Arise
-> ```
+> Your loyal AI companion in the terminal.
 
-## Disclaimer
+Igris Soul is a personal AI assistant that lives directly in your computer's terminal.
 
-This project sends your prompts to Google Gemini and may send web-search requests to Tavily. Do not enter passwords, private keys, personal data, confidential business information, or any other sensitive information into the assistant.
+Inspired by **Igris from Solo Leveling**, it combines **Google Gemini** with **Tavily web search** to help you ask questions, learn, search for recent information, and interact with an AI assistant without opening a browser.
 
-You are responsible for reviewing generated answers and for the API usage and charges associated with your API keys.
+You simply type:
 
-This project is provided for educational and personal use without guarantees about accuracy, availability, or fitness for a particular purpose.
-
----
-
-## Requirements
-
-Before installing Igris Soul, make sure you have:
+```bash
+Arise
+```
 
-* Node.js 20 or newer
-* A Google Gemini API key
-* A Tavily API key for current-information searches
-* An npm account if you want to install or publish the package through npm
+And Igris awakens.
 
 ---
 
-# Installation
-
-## Install Globally
-
-To use Igris Soul from anywhere on your computer:
+## ✨ What is Igris Soul?
 
-```bash
-npm install -g igris-soul
-```
+Think of Igris Soul as your own AI assistant that runs directly from your terminal.
 
-After installation, start Igris with:
+Instead of opening a website and starting a chat, open your terminal and type:
 
 ```bash
 Arise
 ```
 
-You can run `Arise` from any directory.
+Igris comes online and waits for your commands.
 
 For example:
 
-```bash
-C:\Users\YourName> Arise
+```text
+Who are you?
 ```
 
-or:
-
-```bash
-D:\Projects\MyProject> Arise
+```text
+Explain linked lists to me.
 ```
 
-or:
+```text
+What are the latest AI developments?
+```
 
-```bash
-E:\Anything> Arise
+```text
+What is happening in the Indian stock market?
 ```
 
-Igris does not depend on the directory from which you launch it.
+Google Gemini handles the AI conversation, while Tavily allows Igris to search the web when fresh information is needed.
 
 ---
 
-# First-Time Setup
+## 🧠 What Can Igris Do?
 
-On the first launch, Igris automatically creates its configuration directory in your home directory:
+### 💬 AI Conversations
 
-```text
-~/.igris/
-```
+Have natural conversations with your AI assistant.
 
-It will automatically create:
+You can ask questions, learn concepts, brainstorm ideas, get explanations, or simply talk to Igris.
 
-```text
-~/.igris/
-├── .env
-└── user.json
-```
+### 🌐 Fresh Web Information
 
-You do **not** need to manually create these files.
+Igris can search the web when you need information that may have changed recently.
 
-Igris will ask for the required API keys if they are not already configured:
+For example:
 
 ```text
-Enter your Gemini API key:
-Enter your Tavily API key:
+What are the latest AI news in India?
 ```
 
-The keys are then stored locally in:
-
 ```text
-~/.igris/.env
+What are the latest stock market trends?
 ```
 
-On Windows, this is typically:
+### 👨‍💻 Programming Companion
 
-```text
-C:\Users\YourName\.igris\.env
-```
+Igris can help with:
 
-Your name is stored separately in:
+* Programming concepts
+* Data structures
+* Algorithms
+* Debugging
+* Code explanations
+* Software development
+* Machine learning concepts
+* Technical questions
 
-```text
-C:\Users\YourName\.igris\user.json
-```
+### ⚔️ Solo Leveling Inspired Personality
 
-On future launches, Igris automatically loads the saved configuration.
+Igris isn't just another terminal chatbot.
+
+Its personality is inspired by the loyal knight **Igris** from Solo Leveling.
+
+Expect your AI assistant to have a little more character than the average chatbot.
 
 ---
 
-# Configuration
+# 🚀 Getting Started
 
-The automatically created `.env` file contains:
+Don't worry if you're not a programmer.
 
-```env
-GENAI_API_KEY=your_google_gemini_api_key
-TAVILY_API_KEY=your_tavily_api_key
-```
+If you can copy and paste commands into a terminal, you can set up Igris.
 
-### Environment Variables
+## Step 1 — Install Node.js
 
-| Variable         | Purpose                         |
-| ---------------- | ------------------------------- |
-| `GENAI_API_KEY`  | Google Gemini API key           |
-| `TAVILY_API_KEY` | Tavily API key for web searches |
+Igris requires **Node.js 20 or newer**.
 
-You can manually edit:
+If you already have Node.js installed, check your version:
 
-```text
-~/.igris/.env
+```bash
+node --version
 ```
 
-if you need to change your API keys.
+If the version is `20` or higher, you're ready.
 
-### Security
+If you don't have Node.js, install it from the official Node.js website:
 
-Never commit or share your `.env` file.
+**https://nodejs.org/**
 
-Never put real API keys inside the source code.
+After installing Node.js, reopen your terminal.
 
-The `.env` file contains sensitive credentials and should remain on your local machine.
+---
 
-The project includes `.env.example` as a safe template:
+## Step 2 — Install Igris Soul
 
-```env
-GENAI_API_KEY=
-TAVILY_API_KEY=
+Open your terminal and run:
+
+```bash
+npm install -g igris-soul
 ```
 
+The `-g` means that Igris is installed globally.
+
+This allows you to use the `Arise` command from anywhere on your computer.
+
 ---
 
-# Running Igris
+## Step 3 — Awaken Igris
 
-After installation:
+After installation, run:
 
 ```bash
 Arise
 ```
 
-You will see:
+You should see something similar to:
 
 ```text
 +----------------------+
@@ -178,231 +155,364 @@ Hi, My Lord, I am Igris, your loyal servant.
 How may I assist you today?
 ```
 
-You can then enter your prompts directly in the terminal.
+Igris is now online.
 
-Example:
+---
 
-```text
-You: Explain binary search in Java
+# 🔑 First-Time Setup
 
-Igris:
-...
-```
+The first time you run Igris, it will ask for two API keys.
 
-To exit the assistant:
+Don't worry — this is a normal part of the setup.
+
+You will be asked for:
 
 ```text
-exit
+Enter your Gemini API key:
 ```
 
-or:
+and:
 
 ```text
-quit
+Enter your Tavily API key:
 ```
 
+You only need to provide these during setup.
+
+Igris automatically creates its own configuration folder and stores your keys locally.
+
+You **do not need to manually create a `.env` file**.
+
 ---
 
-# Features
-
-* Interactive terminal-based AI assistant
-* Google Gemini-powered responses
-* Streaming AI responses
-* Tavily web search for current information
-* Conversation history during the current session
-* Personalized responses using your saved name
-* First-launch name setup
-* Persistent configuration
-* Automatic `.igris` directory creation
-* Automatic `.env` creation
-* Global CLI access
-* Runs from any directory
-* `Arise` command for launching the assistant
+# 🗝️ Getting Your API Keys
+
+## Google Gemini API Key
+
+Igris uses Google's Gemini models to power its AI.
+
+You need a Gemini API key.
+
+Create one through Google's Gemini API / AI Studio platform:
+
+**https://aistudio.google.com/**
+
+When Igris asks for the key, simply paste it into the terminal.
 
 ---
 
-# Local Development
+## 🌐 Tavily API Key
 
-If you want to run Igris Soul directly from the source code instead of installing it globally:
+Tavily provides Igris with web-search capabilities.
 
-Clone or download the repository and enter the project directory.
+Create a Tavily API key through:
 
-Install dependencies:
+**https://tavily.com/**
 
-```bash
-npm install
+When Igris asks for the key, paste it into the terminal.
+
+---
+
+# 📁 Where Does Igris Store My Configuration?
+
+Igris automatically creates:
+
+```text
+~/.igris/
 ```
 
-Then start Igris:
+Inside it, you'll find:
 
-```bash
-npm start
+```text
+.igris/
+├── .env
+└── user.json
 ```
 
-You can also run:
+### `.env`
 
-```bash
-node index.js
+Stores your API keys locally.
+
+For example:
+
+```text
+GENAI_API_KEY=your_gemini_key
+TAVILY_API_KEY=your_tavily_key
 ```
 
-The same `~/.igris/.env` configuration is used.
+### `user.json`
+
+Stores your name so Igris can remember how to address you.
 
 ---
 
-# Test the Package Locally
+# 🔐 API Key Safety
 
-Before publishing a new version to npm, you can test the CLI directly from the package directory.
+Your API keys are stored in your local Igris configuration folder.
 
-Install the local package globally:
+You don't need to put your API keys inside the project source code.
 
-```bash
-npm install -g .
+**Never share your API keys publicly.**
+
+Do not post them on:
+
+* GitHub
+* Social media
+* Screenshots
+* Public forums
+* Public code repositories
+
+---
+
+# 💻 Using Igris
+
+Once Igris is running, simply type your question.
+
+For example:
+
+```text
+You: Explain recursion in simple terms.
 ```
 
-Then run:
+Igris will respond directly in your terminal.
 
-```bash
-Arise
+You can continue asking questions for as long as you want.
+
+To close Igris, type:
+
+```text
+exit
 ```
 
-This allows you to test the global CLI behavior using your local source code.
+or:
+
+```text
+quit
+```
 
 ---
 
-# Updating Igris Soul
+# ⚡ Quick Start
 
-When a new version is published, update your global installation with:
+If Node.js is already installed:
 
 ```bash
-npm install -g igris-soul@latest
+npm install -g igris-soul
 ```
 
-Your personal configuration remains outside the npm package:
+Then:
 
-```text
-~/.igris/
-├── .env
-└── user.json
+```bash
+Arise
 ```
 
-Therefore, updating the package does not require you to enter your API keys again.
+That's it.
 
 ---
 
-# Uninstalling
+# 🛠️ Available Commands
 
-To remove the globally installed package:
+You can launch Igris using:
 
 ```bash
-npm uninstall -g igris-soul
+Arise
 ```
 
-Your personal Igris configuration remains in:
+You can also use:
+
+```bash
+arise
+```
+
+```bash
+igris
+```
+
+```bash
+igris-soul
+```
+
+All of these launch the same Igris assistant.
+
+---
+
+# 🧩 How Igris Works
+
+At a high level, Igris combines several technologies:
 
 ```text
-~/.igris/
+                YOU
+                 │
+                 ▼
+             ┌───────┐
+             │ IGRIS │
+             └───┬───┘
+                 │
+        ┌────────┴────────┐
+        ▼                 ▼
+   Google Gemini       Tavily Search
+   AI reasoning       Fresh web data
+        │                 │
+        └────────┬────────┘
+                 ▼
+             IGRIS RESPONSE
 ```
 
-If you want to completely remove your local Igris configuration as well, delete the `.igris` directory manually.
+### Google Gemini
+
+Provides the AI intelligence behind Igris.
+
+### Tavily
+
+Allows Igris to retrieve fresh information from the web when needed.
+
+### Terminal CLI
+
+Makes the entire experience available directly from your command line.
 
 ---
 
-# Publishing to npm
+# 🧑‍💻 For Developers
 
-If you are the package maintainer and want to publish a new version:
+Igris Soul is built using:
 
-First, log in to npm:
+* Node.js
+* Google Gemini
+* LangChain
+* Tavily
+* Zod
+* dotenv
+
+Install it with:
 
 ```bash
-npm login
+npm install -g igris-soul
 ```
 
-Verify your account:
+Run it with:
 
 ```bash
-npm whoami
+Arise
 ```
 
-Run the tests:
+Igris Soul is primarily designed as a **global terminal AI assistant**, rather than a library that you import into another application.
 
-```bash
-npm test
+---
+
+# 📦 npm Package
+
+Package name:
+
+```text
+igris-soul
 ```
 
-Check what will be included in the package:
+Install:
 
 ```bash
-npm publish --dry-run
+npm install -g igris-soul
 ```
 
-If everything looks correct, publish:
+Launch:
 
 ```bash
-npm publish
+Arise
 ```
 
-## Updating the Version
+---
+
+# 🐛 Troubleshooting
 
-npm does not allow publishing the same package version twice.
+## `Arise` is not recognized
 
-For a bug fix:
+Make sure Igris is installed globally:
 
 ```bash
-npm version patch
+npm install -g igris-soul
 ```
 
-For a new feature:
+Then restart your terminal and run:
 
 ```bash
-npm version minor
+Arise
 ```
 
-For a breaking change:
+You can check whether Igris is installed with:
 
 ```bash
-npm version major
+npm list -g igris-soul
 ```
 
-Then publish the new version:
+---
 
-```bash
-npm publish
-```
+## Igris asks for my API key again
 
-Example:
+This usually means the required API key isn't currently stored in your local Igris configuration.
 
-```text
-1.0.0 → 1.0.1
-```
+Simply enter the requested API key again.
+
+Igris will save it locally for future sessions.
 
 ---
 
-# Package Usage
+## Igris doesn't provide recent information
 
-Igris Soul is primarily designed as a global terminal assistant.
+Make sure your Tavily API key is configured correctly.
 
-Install:
+Tavily provides Igris's web-search capability.
 
-```bash
-npm install -g igris-soul
-```
+---
+
+# ❤️ Why I Built Igris
 
-Run:
+Igris Soul started as an experiment in building a personal AI assistant that doesn't live inside a browser.
+
+The goal was simple:
+
+> **Make AI feel like a tool that's always available on your machine.**
+
+Open a terminal.
+
+Type:
 
 ```bash
 Arise
 ```
 
-The package is installed globally, while user-specific configuration is stored separately in:
+And your assistant is ready.
 
-```text
-~/.igris/
-```
+---
+
+# ⚔️ The Philosophy
+
+Igris is inspired by one simple idea:
+
+> **An assistant should be ready when you need it.**
+
+No browser.
 
-This allows Igris to maintain its configuration independently of the directory from which it is launched.
+No complicated interface.
+
+Just your terminal, your commands, and your AI companion.
+
+---
+
+# 📜 License
+
+ISC License
 
 ---
 
-# License
+# ⭐ Support the Project
+
+If you find Igris Soul useful, consider giving the project a ⭐ on GitHub and sharing it with other developers and AI enthusiasts.
+
+Every bit of support helps the project grow.
+
+---
+
+# ⚔️ Arise.
+
+Your terminal awaits.
 
-ISC
+**Igris is ready, My Lord.**

package/cli.cjs

@@ -1,13 +1,9 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 const { spawn } = require("node:child_process");
-const { fileURLToPath } = require("node:url");
 const path = require("node:path");
 
-const packageDir = path.dirname(
-  fileURLToPath(require.resolve("./package.json")),
-);
-
+const packageDir = __dirname;
 const indexPath = path.join(packageDir, "index.js");
 
 const child = spawn(process.execPath, [indexPath, ...process.argv.slice(2)], {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "igris-soul",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "A terminal AI assistant powered by Gemini and Tavily.",
   "license": "ISC",
   "author": "Barshan Majumdar",