Skip to content

Brand refresh: J1 v2 README template #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
OneByJorah wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Brand refresh: J1 v2 README template #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
155 changes: 47 additions & 108 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,133 +1,72 @@
<!-- j1-brand:v2 -->
<div align="center">
<img src="https://img.shields.io/badge/Python-3.10+-3776AB?style=for-the-badge&logo=python&logoColor=white">
<img src="https://img.shields.io/badge/FastAPI-009688?style=for-the-badge&logo=fastapi&logoColor=white">
<img src="https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=docker&logoColor=white">
<img src="https://img.shields.io/badge/AI-FF6F00?style=for-the-badge&logo=openai&logoColor=white">
<img src="https://img.shields.io/badge/license-MIT-blue?style=for-the-badge">
</div>

<br>

<div align="center">
<h1>🎫 CommandDesk</h1>
<p><strong>Self-Hosted AI Helpdesk Agent</strong></p>
<p>100% local, AI-powered helpdesk with multi-platform ticketing, knowledge base, and multi-channel communication</p>
<p>
<a href="#-features">Features</a> •
<a href="#-quick-start">Quick Start</a> •
<a href="#-architecture">Architecture</a> •
<a href="#-integrations">Integrations</a>
</p>
</div>

---
# CommandDesk

## ✨ Features
A self-hosted, 100% local AI helpdesk agent — multi-platform ticketing, email-to-ticket ingestion, admin dashboard with live cost tracking.

- **AI-Powered Ticketing** — Auto-respond, triage, and resolve tickets via local LLMs
- **Multi-Platform Support** — osTicket, Freshdesk, Zammad adapters
- **Multi-Channel** — WhatsApp, Email (IMAP), and web interface
- **Knowledge Base** — ChromaDB semantic search for instant answers
- **Admin Dashboard** — Analytics, human takeover, and management
- **Security** — Rate limiting, content filtering, PII detection
- **Workflow Automation** — n8n integration for complex automation
- **Plug-in Architecture** — Extend with custom adapters and tools
[![GitHub](https://img.shields.io/badge/github-OneByJorah%2FCommandDesk-FFB300?style=for-the-badge&labelColor=0d0d0c)](https://github.com/OneByJorah/CommandDesk)
[![License](https://img.shields.io/badge/license-MIT-FFB300?style=for-the-badge&labelColor=0d0d0c)](LICENSE)
[![Language](https://img.shields.io/badge/Python-FFB300?style=for-the-badge&labelColor=0d0d0c)](https://python.org)
[![Built by](https://img.shields.io/badge/built%20by-JorahOne%20LLC-FFB300?style=for-the-badge&labelColor=0d0d0c)](https://github.com/OneByJorah)

## 🚀 Quick Start
</div>

```bash
git clone https://github.com/OneByJorah/CommandDesk.git
cd CommandDesk
cp .env.example .env
# Edit .env with your configuration
docker compose up -d
```
---

## 🏗️ Architecture
## Why This Exists

```
┌──────────────────────────────────────────────────────────┐
│ CommandDesk │
│ │
│ ┌─────────────┐ ┌─────────────┐ ┌──────────────────┐ │
│ │ Ticket │ │ AI │ │ Knowledge │ │
│ │ Platforms │ │ Engine │ │ Base │ │
│ │ osTicket │ │ Ollama │ │ ChromaDB │ │
│ │ Freshdesk │ │ llama.cpp │ │ Qdrant │ │
│ │ Zammad │ │ OpenAI │ │ │ │
│ └──────┬──────┘ └──────┬──────┘ └────────┬─────────┘ │
│ │ │ │ │
│ └────────────────┼───────────────────┘ │
│ ▼ │
│ ┌──────────────────────┐ │
│ │ Communication Layer │ │
│ │ WhatsApp · Email · │ │
│ │ Web Interface │ │
│ └──────────────────────┘ │
└──────────────────────────────────────────────────────────┘
```
Managed helpdesks nickel-and-dime you per agent, per ticket, per integration. CommandDesk is a fully local alternative that runs LLMs (Ollama, llama.cpp, or OpenAI-compatible), connects to osTicket, Freshdesk, and Zammad, ingests email via IMAP, and gives you an admin dashboard with real-time cost tracking — all behind `docker compose up`.

## 📡 Integrations
## Key Features

| Platform | Type | Description |
|----------|------|-------------|
| **osTicket** | Ticketing | Open-source ticket system adapter |
| **Freshdesk** | Ticketing | Cloud-based ticketing |
| **Zammad** | Ticketing | Open-source support system |
| **WhatsApp** | Channel | WhatsApp messaging integration |
| **Email (IMAP)** | Channel | Email-to-ticket conversion |
| **ChromaDB** | Knowledge | Vector search for knowledge base |
| **n8n** | Automation | Workflow automation |
| Feature | Why It Matters |
|---|---|
| AI-powered auto-response & triage | Local LLMs resolve tickets without sending data to third parties |
| Multi-platform ticketing | osTicket, Freshdesk, and Zammad support in one deploy |
| Email-to-ticket (IMAP) | Converts inbound email into tickets automatically |
| WhatsApp integration | Lets users file and track tickets via WhatsApp |
| Vector knowledge base (ChromaDB) | Semantic search across your documentation for accurate answers |
| n8n workflow integration | Chain helpdesk events into automations |
| PII detection & rate limiting | Built-in safety layers before responses reach customers |

## 🐳 Docker Compose
## Quick Start

```bash
# Start with AI engine
git clone https://github.com/OneByJorah/CommandDesk.git
cd CommandDesk
cp .env.example .env # configure your LLM backend, ticketing platform, etc.
docker compose up -d

# Start with development config
docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d

# View logs
docker compose logs -f

# Stop
docker compose down
```

## 📁 Project Structure
## Architecture

```
CommandDesk/
├── admin/ # Admin dashboard
├── compose/ # Docker Compose configs
├── config/ # Application configuration
├── scripts/ # Utility scripts
├── skills/ # AI agent skills
├── ticket_platforms/ # osTicket, Freshdesk, Zammad adapters
├── tools-ui/ # Web UI components
├── Dockerfile # Backend Docker image
├── Dockerfile.email # Email service image
├── Dockerfile.whatsapp # WhatsApp service image
├── docker-compose.yml # Main deployment
├── Makefile # Build automation
└── requirements.txt # Python dependencies
┌──────────────┐ ┌──────────────┐ ┌──────────────┐
│ Ticketing │◀───▶│ CommandDesk │────▶│ AI Engine │
│ osTicket │ │ FastAPI │ │ Ollama / │
│ Freshdesk │ │ Admin UI │ │ llama.cpp │
│ Zammad │ │ Web UI │ │ OpenAI API │
└──────────────┘ └──────┬───────┘ └──────────────┘
│
┌──────▼───────┐
│ ChromaDB │
│ (vector KB) │
└──────────────┘
```

## 🔒 Security
## Documentation

- Rate limiting on all API endpoints
- Content filtering for malicious payloads
- PII detection and redaction
- Environment-based configuration (`.env` never committed)
| Doc | Description |
|---|---|
| [Setup Guide](docs/setup.md) | Configuration and first-run walkthrough |
| [Platform Integration](docs/platforms.md) | Connecting osTicket, Freshdesk, and Zammad |
| [AI Configuration](docs/ai.md) | Choosing and tuning your LLM backend |

## 📄 License
---

MIT © Jhonattan L. Jimenez
## License

---
MIT © JorahOne, LLC — see [LICENSE](LICENSE)

<div align="center">
<p>🤖 AI-powered helpdesk, fully self-hosted</p>
<p><a href="https://github.com/OneByJorah">@OneByJorah</a></p>
</div>
<sub>Part of the JorahOne infrastructure ecosystem.</sub>
Loading