https://github.com/joanium/joanium
Your smart, reliable, and friendly personal AI assistant.
https://github.com/joanium/joanium
agent ai ai-agent automation claude-code codex deepseek gemini gemini-pro hermes-agent joanium kilo-code kimi minimax open-claude-code open-code open-human openclaw opencode qwen
Last synced: 4 days ago
JSON representation
Your smart, reliable, and friendly personal AI assistant.
- Host: GitHub
- URL: https://github.com/joanium/joanium
- Owner: Joanium
- License: apache-2.0
- Created: 2026-05-01T17:16:25.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2026-06-09T04:32:17.000Z (9 days ago)
- Last Synced: 2026-06-09T06:28:22.847Z (9 days ago)
- Topics: agent, ai, ai-agent, automation, claude-code, codex, deepseek, gemini, gemini-pro, hermes-agent, joanium, kilo-code, kimi, minimax, open-claude-code, open-code, open-human, openclaw, opencode, qwen
- Language: JavaScript
- Homepage: https://www.joanium.com
- Size: 235 MB
- Stars: 82
- Watchers: 23
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Agents: AGENTS.md
Awesome Lists containing this project
README
# 📚 Joanium Docs
Welcome to the Joanium documentation. Here's where to start depending on what you're trying to do.
## 🗺️ Recommended Reading Order
If you're new to the codebase, read in this order:
1. **[Architecture.md](Architecture.md)** — understand the mental model and how the app is assembled
2. **[Features.md](Features.md)** — see the full product surface and what's already built
3. **[Data-And-Persistence.md](Data-And-Persistence.md)** — understand where state lives and why
4. **[Extension-Guide.md](Extension-Guide.md)** — learn how to add new features, engines, pages, and services
5. **[Where-To-Change-What.md](Where-To-Change-What.md)** — day-to-day maintenance map
6. **[Development-Workflow.md](Development-Workflow.md)** — scripts, packaging, and contributor workflow
## ⚡ Quick Lookup
| I want to... | Read this |
| ----------------------------------- | -------------------------------------------------- |
| Understand how the app boots | [Architecture.md](Architecture.md) |
| See what features already exist | [Features.md](Features.md) |
| Find where user data is stored | [Data-And-Persistence.md](Data-And-Persistence.md) |
| Add a new integration or feature | [Extension-Guide.md](Extension-Guide.md) |
| Change a specific page or subsystem | [Where-To-Change-What.md](Where-To-Change-What.md) |
| Build, audit, or package the app | [Development-Workflow.md](Development-Workflow.md) |
## 🧠 The Mental Model in 30 Seconds
Think of Joanium as **5 layers stacked on top of each other:**
```
┌─────────────────────────────────────────────┐
│ 5. Local data, markdown libraries, prompts │ ← Skills, Personas, Memories, Config
├─────────────────────────────────────────────┤
│ 4. Renderer pages + shared UI │ ← Chat, Agents, Automations, etc.
├─────────────────────────────────────────────┤
│ 3. Long-lived engines + services │ ← Agents engine, Automation engine, etc.
├─────────────────────────────────────────────┤
│ 2. Discovery + composition │ ← Feature Registry, Boot.js
├─────────────────────────────────────────────┤
│ 1. Electron boot + process plumbing │ ← App.js, Main process, Preload
└─────────────────────────────────────────────┘
```
Once that clicks, the rest of the repo becomes much easier to navigate.
> 💡 **Key insight:** Joanium is not organised around one monolithic app file. It's **assembled** through workspace package discovery. Add a package → it just shows up at boot.
## 📁 Where the important folders live
```text
Packages/Main/ ← Boot, discovery, services, IPC registration
Packages/Features/ ← Long-lived background runtimes (engines)
Packages/Capabilities/ ← Integration packages (GitHub, Google, etc.)
Packages/Pages/ ← User-facing pages
Packages/Renderer/ ← SPA shell that mounts pages + sidebar
Packages/System/ ← Shared contracts and low-level helpers
```