# Berkelium - Quck Start

Welcome to Berkelium, an intelligent AI assistant that lives in your terminal. Powered by Node.js, TypeScript, and the Google Gemini API, Berkelium is here to help you with your coding tasks, answer your questions, and streamline your workflow.

# What is Berkelium?

Think of Berkelium as a smart companion that understands your code and helps you with your development tasks. Whether you need to write code, debug an issue, or simply get some information, Berkelium is here to assist you. It's like having a pair programmer available 24/7, right in your terminal.


# Understanding Berkelium's Output

Berkelium uses a color-coding system to help you quickly identify different types of messages in your terminal.

  • 🔵 User Prompt: This indicates a prompt or question you've entered.
  • 🟢 Success: This signifies a successful AI response or the completion of a task.
  • 🟡 Warning: This alerts you to a potential issue or non-critical problem.
  • 🔴 Error: This highlights a critical error that requires your attention.

# Getting Started

To get started with Berkelium, you'll need to have Node.js and npm installed on your machine. Then, follow these simple steps:

  1. Install dependencies:
    npm i -g berkelium
    
  2. Run the CLI:
    berkelium
    

The first time you run Berkelium, it will ask you for your Google API key. You can get your key from Google AI Studio (opens new window).

We hope you enjoy using Berkelium! If you have any questions or feedback, please feel free to open an issue on our GitHub repository (opens new window).