chitkara-exam-assistant
v1.0.0
Published
A CLI tool to communicate with Gemini and get code solutions directly in the terminal.
Downloads
13
Maintainers
Readme
Chitkara Exam Helper 🎓
A powerful CLI tool to communicate with Google's Gemini AI directly from your terminal. Get code solutions, explanations, and exam prep assistance with beautiful syntax highlighting.
🌟 Features
- 🤖 Direct Gemini Integration with Gemini 1.5 Flash
- 💻 Terminal code highlighting (Python, C++, JS, etc.)
- 🔑 Secure API key storage using configstore
- ⚡ Fast & lightweight Node.js tool
- 🔄 Interactive chat with history support
🛠️ Prerequisites
- Node.js v18+
- npm
👨💻 Installation (For Developers)
Clone the Repository: git clone https://github.com/yourusername/chitkara-exam-helper.git cd chitkara-exam-helper
Install Dependencies: npm install
Link Locally: npm link
Run the Tool: chitkara-helper
🚀 Publishing to NPM
Login: npm login
Check package name: (chitkara-exam-helper)
Publish: npm publish --access public
🌍 Installation (For End Users)
Global Install: npm install -g chitkara-exam-helper
Mac/Linux (if permission error): sudo npm install -g chitkara-exam-helper
📖 Usage
Start the tool: chitkara-helper
First-Time Setup:
- It will ask for your Gemini API Key
- Get your key from: https://aistudio.google.com/app/apikey
- Paste it (input is hidden)
- Key can be saved permanently
Commands:
- Ask a question → type & press enter
- Exit → type: exit or quit
Example Interaction: You: Write a binary search program in C++ Gemini: Here is the code...
🐛 Troubleshooting
Command not found: npm install -g chitkara-exam-helper
Invalid API Key:
- Tool will detect and remove bad key automatically
- Restart tool to enter a new one
Update tool: npm install -g chitkara-exam-helper@latest
🧩 Project Structure (Example)
.
├─ bin/
│ └─ index.js
├─ utils/
│ ├─ apiKey.js
│ └─ ui.js
├─ package.json
└─ README.md🏗️ Tech Stack
- Node.js
- Google Gemini 1.5 Flash (@google/generative-ai)
- inquirer
- chalk
- ora
- marked + marked-terminal
- configstore
