ekushscript/README.md

EkushScript is a Bengali Romanized programming language designed to be simple, fun, and expressive — written in TypeScript.

# 🇧🇩 EkushScript CLI

**EkushScript** is a Bengali Romanized programming language designed to be simple, fun, and expressive — written in TypeScript. This CLI lets you run `.ekush` files, use an interactive REPL, and compile to JavaScript.

> নিজের ভাষায় প্রোগ্রামিং শুরু হোক আজই! 🇧🇩

---


## ✨ Features

- 🔤 Bengali Romanized syntax (rakho, bolo, kaj, jodi, ghuro, etc.)
- 🌀 Interactive REPL for quick experimentation
- 🧪 Rich language features including variables, loops, functions, and conditionals
- 🧾 Compile `.ekush` files to JavaScript
- 🧘 Beginner-friendly with familiar Bengali-inspired keywords
- 📚 Comprehensive documentation and examples

> 🌱 EkushScript is actively growing! Check out our [Coming Soon](#-coming-soon) section to see what's next.

---


## 🚀 Installation

```bash
npm install -g ekushscript
```

> This will globally install the CLI command: `ekush`

---


## 🧪 Example

Create a file called `hello.ekush`:

```ekush
rakho nam = "EkushScript";
bolo("Hello," nam "!");
```

Run it:

```bash
ekush run hello.ekush
```

---


## 🌀 Use REPL

```bash
ekush repl
```

Start typing Bengali-flavored code like:

```ekush
rakho x = 10;
bolo(x gun 2);
```

---


## 🛠 Commands

| Command | Description |
|---------|-------------|
| `ekush run <file>` | Run a `.ekush` file |
| `ekush repl` | Launch interactive REPL |
| `ekush compile <file>` | Compile `.ekush` to `.js` |
| `ekush -v` / `ekush --version` | Show CLI version |

---


## 📚 Documentation

For detailed documentation about **EkushScript**'s syntax, features, and examples, check out our documentation:

- [English Documentation](https://github.com/MuzakkirHossainMinhaz/ekushscript-docs/blob/main/docs/en.md)
- [বাংলা ডকুমেন্টেশন](https://github.com/MuzakkirHossainMinhaz/ekushscript-docs/blob/main/docs/bn.md)

## 🌱 Coming Soon

### Core Language Features

- 🔄 Object-Oriented Programming
  - Classes and Objects
  - Inheritance
  - Encapsulation
- 🎯 Type System
  - Static Type Checking
  - Type Inference
- 🐞 Error Handling
  - Try-Catch Blocks

### Built-in Features

- 📚 Data Structures
  - Maps and Sets
  - Queues and Stacks
- 🛠 Utility Functions
  - String Manipulation
  - Math Operations
  - Date/Time Handling
- 🌐 I/O Operations
  - File System

### Developer Tools

- 🌐 Web Playground
- 🧩 VSCode Extension

---


## 📜 License

MIT © Muzakkir Hossain Minhaz