# 🦅 Bielik

**Polish AI Assistant CLI** - Advanced command-line interface for local HuggingFace model execution with Context Provider Commands.

**Bielik** is a groundbreaking Polish language model created by **[Speakleash](https://speakleash.org/)** - a foundation dedicated to the development of Polish artificial intelligence.

> 🇵🇱 **Bielik models** are available on **[HuggingFace Hub](https://huggingface.co/speakleash)**

[![Build](https://img.shields.io/github/actions/workflow/status/tom-sapletta-com/bielik/python-app.yml?branch=main)](https://github.com/tom-sapletta-com/bielik/actions)
[![PyPI](https://img.shields.io/pypi/v/bielik.svg)](https://pypi.org/project/bielik/)
[![Downloads](https://img.shields.io/pypi/dm/bielik)](https://pypi.org/project/bielik/)
[![Python](https://img.shields.io/pypi/pyversions/bielik.svg)](https://www.python.org/)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
[![Stars](https://img.shields.io/github/stars/tom-sapletta-com/bielik?style=social)](https://github.com/tom-sapletta-com/bielik)
[![Docker](https://img.shields.io/badge/Docker-Ready-blue?logo=docker)](docs/DOCKER.md)
[![Conda](https://img.shields.io/badge/Conda%20Env-ready-green?logo=anaconda)](docs/INSTALLATION.md)
[![HuggingFace](https://img.shields.io/badge/HuggingFace-SpeakLeash-orange?logo=huggingface)](https://huggingface.co/speakleash)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](docs/CONTRIBUTING.md)

---

## 🚀 **Quick Start**

### **One-liner Installation**
```bash
curl -sSL https://raw.githubusercontent.com/tom-sapletta-com/bielik/main/quick-install.sh | bash
```

### **Basic Usage**
```bash
# Interactive mode
bielik

# Single prompt
bielik -p "Jak się masz?"

# Context Provider Commands (instant execution)
bielik -p "calc: 2 + 3 * 4"
bielik -p "folder: ."
```

---

## ✨ **Key Features**

- **🎯 Local Execution** - Complete privacy, no external API calls  
- **💬 Polish Language Optimized** - Built for Polish conversation and analysis
- **⚡ Context Provider Commands** - Instant data processing without AI model loading
- **🖼️ Vision Capabilities** - Image analysis and visual question answering
- **📁 Document Processing** - PDF, DOCX, web content analysis
- **🐳 Docker Ready** - Comprehensive multiplatform testing
- **🔧 Extensible** - Easy custom command development

---

## 📚 **Complete Documentation**

**📖 For detailed information, visit our comprehensive documentation:**

### **📋 Core Documentation**
- **[📖 Documentation Home](docs/README.md)** - Navigation and overview
- **[📥 Installation Guide](docs/INSTALLATION.md)** - Conda, manual, Docker, troubleshooting
- **[🏗️ System Architecture](docs/ARCHITECTURE.md)** - Design, components, data flow
- **[⚡ Usage Guide](docs/USAGE.md)** - Commands, examples, best practices

### **🛠️ Development**  
- **[🤝 Contributing Guide](docs/CONTRIBUTING.md)** - Development setup, standards, PR process
- **[🔌 Python API](docs/API.md)** - Client usage, WebSocket, error handling
- **[🎯 Context Provider Commands](docs/CONTEXT_PROVIDERS.md)** - Custom command development
- **[🐳 Docker Testing](docs/DOCKER.md)** - Multiplatform testing framework

---

## 🤝 **Contributing**

We welcome contributions! See our **[Contributing Guide](docs/CONTRIBUTING.md)** for:
- Development setup and standards
- Pull request process  
- Code quality guidelines
- Testing requirements

---

## 📄 **License**

This project is licensed under the **Apache License 2.0** - see the [LICENSE](LICENSE) file for details.

---

**Author:** Tom Sapletta  
**🏢 Founder & CEO at [Telemonit](https://www.telemonit.com)** - Edge computing power solutions  
**🌍 Based in Germany | Open to collaboration**




  
