|
1 | 1 | # Claude Owl 🦉 |
2 | 2 |
|
3 | | -> A beautiful, open-source desktop UI for managing Claude Code configurations, settings, and features. |
| 3 | +**Stop editing JSON and MD files. Manage your Claude Code setup visually.** |
4 | 4 |
|
5 | 5 | [](https://opensource.org/licenses/MIT) |
6 | 6 | [](https://nodejs.org/) |
7 | 7 | [](CONTRIBUTING.md) |
8 | | -[](#status) |
9 | | - |
10 | | -**Status:** 🚀 Beta - Actively developed, currently supports **macOS and Windows**. |
| 8 | +[](#) |
11 | 9 |
|
12 | 10 | --- |
13 | 11 |
|
14 | | -## What is Claude Owl? |
| 12 | +## The Problem |
15 | 13 |
|
16 | | -Claude Owl is a desktop application for managing [Claude Code](https://code.claude.com) configurations through an intuitive visual interface. Instead of manually editing JSON and YAML configuration files in your text editor or through the Claude Code CLI. |
| 14 | +Claude Code is powerful but configuration is painful: |
| 15 | +- Hand-editing JSON for permissions rules? Error-prone. |
| 16 | +- Managing MCP servers across projects? Copy-paste hell. |
| 17 | +- Finding that one subagent you created? Good luck grep-ing through `.claude/`. |
| 18 | +- You want to know any metrics about your Claude Code usage? You need to download yet another tool. |
17 | 19 |
|
18 | | -## Current Features (Beta) |
| 20 | +## The Solution |
19 | 21 |
|
20 | | -For a complete list of features, see [SCREENSHOTS.md](SCREENSHOTS.md) and [CHANGELOG.md](CHANGELOG.md). |
| 22 | +Claude Owl gives you a visual interface for everything Claude Code configuration: |
21 | 23 |
|
22 | 24 |  |
23 | 25 |
|
24 | | -### 🎄 2025 Year in Review |
| 26 | +**No more terminal commands. No more JSON typos. Just point, click, done.** |
25 | 27 |
|
26 | | -Celebrate your year of AI-powered development! Claude Owl now includes a festive Year in Review feature that showcases your 2025 coding journey with Claude Code: |
| 28 | +## What You Can Do |
27 | 29 |
|
28 | | -- **📊 Beautiful Stats**: Token usage, costs, sessions, and activity patterns |
29 | | -- **🏆 Achievement Badges**: Earn badges for milestones and coding habits |
30 | | -- **🎯 Model Insights**: See your favorite Claude models and usage breakdown |
31 | | -- **📈 Activity Analytics**: Peak coding months, longest streaks, and daily patterns |
32 | | -- **🎁 Social Sharing**: Share your year with customizable stats for Twitter/X |
| 30 | +### Core Features |
| 31 | +- **Settings Editor** - User and project-level settings with search and validation |
| 32 | +- **Permission Rules** - Visual builder with 6 security templates |
| 33 | +- **MCP Servers** - Add, configure, and test Model Context Protocol integrations |
| 34 | +- **Subagents** - Create custom agents with tool restrictions and model selection |
| 35 | +- **Skills & Commands** - Manage skills and import slash commands from GitHub repos |
| 36 | +- **Plugins** - Browse marketplaces, install plugins, enable/disable without editing files |
33 | 37 |
|
34 | | - |
| 38 | +### Power Features |
| 39 | +- **Usage Metrics** - Interactive charts showing spend, tokens, and model breakdown |
| 40 | +- **Status Line Templates** - 10+ pre-built templates with live preview |
| 41 | +- **Dashboard** - Real-time Claude Code detection and API status monitoring |
| 42 | +- **Debug Logs** - View and search Claude Code logs without terminal or importing the whole `.claude` directory into an IDE. |
35 | 43 |
|
36 | | -Available now through January 1, 2026! |
| 44 | +[See all features with screenshots →](https://antonbelev.github.io/claude-owl/screenshots.html) |
37 | 45 |
|
38 | 46 | ## Installation |
39 | 47 |
|
40 | | -### Prerequisites |
| 48 | +### Download (Recommended) |
| 49 | + |
| 50 | +**[📥 Download Latest Release](https://github.com/antonbelev/claude-owl/releases/latest)** |
41 | 51 |
|
42 | | -- **Node.js** >= 18.0.0 |
43 | | -- **npm** >= 9.0.0 |
44 | | -- **Claude Code CLI** ([installation guide](https://code.claude.com/docs/en/quickstart)) |
45 | | -- **macOS or Windows** |
| 52 | +- macOS (Intel + Apple Silicon) |
| 53 | +- Windows (x64 + ARM64) |
46 | 54 |
|
47 | | -### Install from Source |
| 55 | +[Full installation guide →](https://antonbelev.github.io/claude-owl/installation.html) |
48 | 56 |
|
49 | | -Claude Owl is currently in Beta and available for development/testing: |
| 57 | +### Build from Source |
50 | 58 |
|
51 | 59 | ```bash |
52 | | -# Clone the repository |
53 | 60 | git clone https://github.com/antonbelev/claude-owl.git |
54 | 61 | cd claude-owl |
55 | | - |
56 | | -# Install dependencies |
57 | 62 | npm install |
58 | | - |
59 | | -# Run in development mode |
60 | 63 | npm run dev:electron |
61 | 64 | ``` |
62 | 65 |
|
63 | | -### Download Pre-built Binaries |
64 | | - |
65 | | -Pre-built installers are available for macOS and Windows: |
66 | | - |
67 | | -**[📥 Download Latest Release](https://github.com/antonbelev/claude-owl/releases/latest)** |
68 | | - |
69 | | -- **macOS**: `.dmg` files for Intel and Apple Silicon |
70 | | -- **Windows**: `.exe` installer for x64 and ARM64 |
71 | | - |
72 | | -For detailed installation instructions, see our [Installation Guide](https://antonbelev.github.io/claude-owl/installation.html). |
73 | | - |
74 | | -### Build from Source |
75 | | - |
76 | | -```bash |
77 | | -npm run build |
78 | | -npm run package |
79 | | -``` |
| 66 | +**Requirements:** Node.js 18+, Claude Code CLI installed |
80 | 67 |
|
81 | | -## Documentation |
| 68 | +## FAQ |
82 | 69 |
|
83 | | -- [Architecture Overview](docs/architecture.md) - System design and technical details |
84 | | -- [Contributing Guide](CONTRIBUTING.md) - How to contribute |
85 | | -- [Code of Conduct](CODE_OF_CONDUCT.md) - Community guidelines |
86 | | -- [Development Notes](CLAUDE.md) - Development commands and project structure |
87 | | -- [CHANGELOG.md](CHANGELOG.md) - List of changes and updates |
| 70 | +**Does this replace Claude Code?** |
| 71 | +No. Claude Owl is a UI layer on top of Claude Code CLI. You still need Claude Code installed. |
88 | 72 |
|
89 | | -## Tech Stack |
| 73 | +**Is my data safe?** |
| 74 | +100% local. No telemetry, no external servers, no data collection. Everything stays on your machine. |
90 | 75 |
|
91 | | -- **Desktop Framework**: Electron |
92 | | -- **Frontend**: React 18 + TypeScript |
93 | | -- **Build Tool**: Vite |
94 | | -- **State Management**: Zustand |
95 | | -- **Styling**: Tailwind CSS + shadcn/ui |
96 | | -- **Testing**: Vitest + React Testing Library |
| 76 | +**What platforms work?** |
| 77 | +macOS (Intel + Apple Silicon) and Windows (x64 + ARM64). Linux support coming soon. |
97 | 78 |
|
98 | 79 | ## Contributing |
99 | 80 |
|
100 | | -We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. |
101 | | - |
102 | | -To get started: |
| 81 | +PRs welcome! Check [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. |
103 | 82 |
|
| 83 | +Quick start: |
104 | 84 | ```bash |
105 | | -# Fork and clone the repository |
106 | 85 | git clone https://github.com/antonbelev/claude-owl.git |
107 | 86 | cd claude-owl |
108 | | - |
109 | | -# Install dependencies |
110 | 87 | npm install |
111 | | - |
112 | | -# Start development server |
113 | 88 | npm run dev:electron |
114 | 89 | ``` |
115 | 90 |
|
116 | | -## FAQ |
117 | | - |
118 | | -### Does Claude Owl replace Claude Code? |
119 | | - |
120 | | -No, Claude Owl is a UI companion for Claude Code. It manages configurations visually but still uses the Claude Code CLI under the hood. |
121 | | - |
122 | | -### Is my data safe? |
123 | | - |
124 | | -Yes! Claude Owl is completely local-first. All configurations and data stay on your machine. No data is sent to external servers, and no telemetry is collected. |
| 91 | +## Tech Stack |
125 | 92 |
|
126 | | -### What platforms are currently supported? |
| 93 | +Electron + React 18 + TypeScript + Vite + Zustand + Tailwind CSS |
127 | 94 |
|
128 | | -- **macOS** (Intel & Apple Silicon) - ✅ Fully supported |
129 | | -- **Windows** (x64 & ARM64) - ✅ Fully supported |
| 95 | +See [CLAUDE.md](CLAUDE.md) for development notes and [docs/architecture.md](docs/architecture.md) for system design. |
130 | 96 |
|
131 | | -### How can I contribute? |
| 97 | +## Star History |
132 | 98 |
|
133 | | -See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines. |
| 99 | +[](https://star-history.com/#antonbelev/claude-owl&Date) |
134 | 100 |
|
135 | 101 | ## License |
136 | 102 |
|
137 | 103 | Claude Owl is open-source software licensed under the [MIT License](LICENSE). |
138 | 104 |
|
139 | | -## Support |
140 | | - |
141 | | -- 📖 [Documentation](docs/) |
142 | | -- 💬 [Discussions](https://github.com/antonbelev/claude-owl/discussions) |
143 | | -- 🐛 [Issue Tracker](https://github.com/antonbelev/claude-owl/issues) |
144 | | - |
145 | | -## Disclaimer |
| 105 | +--- |
146 | 106 |
|
147 | | -Claude Owl is an independent community project and is **not affiliated with, endorsed by, or sponsored by Anthropic**. Claude is a trademark of Anthropic, Inc. This project uses Claude through the publicly available Claude Code CLI and is not an official Anthropic product. |
| 107 | +**Disclaimer:** Claude Owl is not affiliated with Anthropic. Claude is a trademark of Anthropic PCB. |
148 | 108 |
|
149 | | ---- |
| 109 | +**Support:** [Issues](https://github.com/antonbelev/claude-owl/issues) • [Discussions](https://github.com/antonbelev/claude-owl/discussions) • [Documentation](https://antonbelev.github.io/claude-owl/) |
0 commit comments