Skip to content
/ KuttAI Public

KuttAI is a modern, terminal-based AI assistant for KTU students. It delivers real-time, context-aware academic guidance with a beautiful gradient CLI interface, GPU acceleration, streaming responses, and privacy-first local storageโ€”perfect for exams, assignments, and study support.

License

Notifications You must be signed in to change notification settings

ecocee/KuttAI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

13 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

KuttAI CLI - Your Intelligent Study Companion

KuttAI Banner Node.js License

Platform

KuttAI CLI Demo

Demo Download

๐ŸŒŸ Overview

KuttAI is a beautiful, modern command-line interface AI chatbot designed specifically for KTU students. With its stunning gradient-colored interface and powerful AI capabilities, KuttAI provides intelligent assistance for studies, exams, and all things related to the KTU ecosystem.

Smart KTU Assistant

โœจ Features

Feature Description
๐ŸŽจ Beautiful UI Gradient-colored interface with modern design
โšก Real-time Responses Fast AI-powered answers to academic questions
๐Ÿ“š KTU-Focused Specialized knowledge for KTU curriculum
๐Ÿ”’ Privacy First All data stored locally on your machine
๐ŸŽฏ Smart Context Understands context from previous conversations
๐Ÿ“Š System Integration Displays relevant system information
โšก GPU Optimization Automatically detects GPU and uses it for faster model inference

๐Ÿš€ Quick Start

Method 1: Direct Run with npx (Recommended)

npx kuttai

Method 2: Manual Installation

# Clone the repository
git clone https://github.com/cyberkutti-iedc/kuttai.git

# Navigate to the project directory
cd kuttai

# Install dependencies
npm install

# Download the AI model (Required before first use)
npx --no node-llama-cpp pull --dir ./models <model-file-url>

# Start KuttAI
npm start

โš™๏ธ System Requirements

Component Minimum Recommended
RAM 8 GB 16 GB or more
GPU Not required NVIDIA GPU with 4GB+ VRAM
Storage 10 GB free space 20 GB free space
Node.js v18.0.0+ v20.0.0+
OS Windows 10+, macOS 10.14+, Ubuntu 18.04+ Latest OS version
System Requirements

๐ŸŽฎ Usage Guide

Starting KuttAI

# After installation
npm start

# Or directly with node
node index.js

Basic Commands

Command Description Example
Just type your question Get answers about studies, exams, or KTU What are the important topics for CS2040?
/profile Set up your student profile /profile set semester=4 department=CSE
/help See all available commands /help
/about Learn more about KuttAI /about
Ctrl+C Exit the application -

Example Interaction

โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚                              KuttAI CLI v1.1.0                               โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ You: What are the important topics for CS2040?                               โ”‚
โ”‚                                                                              โ”‚
โ”‚ KuttAI: Based on the current syllabus, the important topics for CS2040       โ”‚
โ”‚ include Data Structures, Algorithms, Trees, Graphs, and Sorting Algorithms.  โ”‚
โ”‚ I recommend focusing on...                                                   โ”‚
โ”‚                                                                              โ”‚
โ”‚ You: When is the S4 CSE end semester exam?                                   โ”‚
โ”‚                                                                              โ”‚
โ”‚ KuttAI: The S4 CSE end semester exams are scheduled for June 15-30, 2024.    โ”‚
โ”‚ I suggest starting your preparation at least 6 weeks in advance.             โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
Interactive Demo

Current Version: v1.1.0

  • โœ… Streaming output for real-time responses
  • โœ… Improved animations and typewriter effects
  • โœ… Tokenizer fixes
  • โœ… GPU layer auto-detection
  • โœ… Beautiful terminal UI with gradient colors
  • โœ… Local AI model integration
  • โœ… KTU-specific knowledge base
  • โœ… Student profile system
  • โœ… Conversation history

๐ŸŽจ UI/UX Features

Color Scheme

KuttAI uses a beautiful gradient color scheme inspired by modern design principles:

  • ๐Ÿ”ต Blue (#1a237e โ†’ #1565c0): Information and system messages
  • ๐Ÿ”ด Red (#b71c1c โ†’ #d32f2f): Errors and important notices
  • ๐ŸŸก Yellow (#f57f17 โ†’ #fbc02d): Warnings and highlights
  • ๐ŸŸข Green (#1b5e20 โ†’ #388e3c): Success messages and positive feedback

Animations & Effects

  • Loading animations with spinning indicators
  • Progress bars for model loading and long operations
  • Typewriter effect for response display
  • Smooth transitions between application states
  • Real-time typing indicators

๐Ÿ”ง Technical Architecture

Built With

  • Node.js - Runtime environment
  • LLama.cpp - AI model integration via node-llama-cpp
  • Custom UI Engine - Terminal interface rendering with blessed
  • Local Storage - Data persistence with JSON files

Model Information

KuttAI uses optimized AI models specifically trained for academic content:

  • Model: hf_mradermacher_ClinIQ-Gemma-2B-v0-hf.IQ4_XS.gguf
  • Size: Approximately 2B parameters
  • Specialization: Educational content, KTU curriculum
  • Download Size: ~1.5GB
  • RAM Usage: ~4GB during operation

๐Ÿค Contributing

We love contributions! Here's how you can help:

Development Setup

# Fork and clone the repository
git clone https://github.com/cyberkutti-iedc/kuttai.git
cd kuttai

# Install dependencies
npm install

# Set up development environment
npm start

# Run tests
npm test

# Build for production
npm run build

Contribution Areas

  • ๐Ÿ› Bug fixes and issue resolution
  • ๐Ÿ’ก New feature implementation
  • ๐Ÿ“š Documentation improvements
  • ๐ŸŽจ UI/UX enhancements
  • ๐Ÿ”ง Performance optimizations

Please read our Contributing Guidelines, CLA, and Code of Conduct before contributing.

๐Ÿ“ License

This project is licensed under the EcoCee-OpenSource License โ€“ see LICENSE for details. Ownership remains with Sreeraj V Rajesh & EcoCee. Contributions are welcome under the CLA.

๐Ÿ™ Acknowledgments

  • Developed by EcoCee
  • Inspired by the needs of KTU students
  • Built with the amazing Node.js ecosystem
  • Thanks to all contributors and testers

๐Ÿ“ž Support

Documentation

Contact

Troubleshooting

Common Issues and Solutions:

  1. Model Download Failed

    # Manual download option
    npx --no node-llama-cpp pull --dir ./models <model-file-url>
  2. Insufficient Memory

    • Close other applications
    • Add swap space (Linux/macOS)
  3. Node Version Issues

    # Update Node.js
    nvm install 18
    nvm use 18
  4. Display Problems

    • Ensure your terminal supports ANSI colors
    • Try using a different terminal emulator

๐Ÿ”ฎ Roadmap

Upcoming Features

  • Voice Interaction - Speak to KuttAI and hear responses
  • Multi-language Support - Assistance in Malayalam and Hindi
  • Mobile App - KuttAI on your smartphone
  • Plugin System - Extend functionality with community plugins
  • Cloud Sync - Sync your preferences across devices
  • Advanced Study Planner - Intelligent study schedule generator

Made with โค๏ธ by EcoCee Innovation Hub

KuttAI Logo

Website Twitter Instagram

About

KuttAI is a modern, terminal-based AI assistant for KTU students. It delivers real-time, context-aware academic guidance with a beautiful gradient CLI interface, GPU acceleration, streaming responses, and privacy-first local storageโ€”perfect for exams, assignments, and study support.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published