mirror of
https://github.com/mfakbar127/Claude-Samurai
synced 2026-06-21 13:57:42 +00:00
update README
This commit is contained in:
Muh. Fani Akbar
@@ -1,95 +1,132 @@
|
||||
# CC Mate - Configure your Claude Code without pain
|
||||
# Claude Samurai - Configure your Claude Code without pain
|
||||
|
||||
<div align="center">
|
||||
|
||||
**A modern desktop application for managing Claude Code configuration files**
|
||||
**Visual configuration manager for Claude Code and MCP**
|
||||
|
||||
[Download Latest Release](https://randynamic.org/ccmate) • [Report Issues](https://github.com/djyde/ccmate/issues) • [Contributing Guide](CONTRIBUTING.md)
|
||||
<img src="src-tauri/icons/icon.png" alt="Claude Samurai icon" width="160" height="160" />
|
||||
|
||||
[](https://www.gnu.org/licenses/agpl-3.0) [](https://github.com/djyde/brew)
|
||||
|
||||
</div>
|
||||
|
||||
## 💝 Sponsor
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td width="180"><img src="https://github.com/user-attachments/assets/c086212b-952c-4a63-9f4c-cb1e5e2d7528" alt="PackyCode" width="150"></td>
|
||||
<td>Thanks to PackyCode for sponsoring this project! PackyCode is a reliable and efficient API relay service provider, offering relay services for Claude Code, Codex, Gemini, and more. PackyCode provides special discounts for our software users: register using <a href="https://www.packyapi.com/register?aff=cc-mate">this link</a> and enter the "cc-mate" promo code during recharge to get 10% off.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
Want to become a sponsor? Contact https://x.com/randyloop
|
||||
|
||||
## 📸 Screenshots
|
||||
|
||||
### Configuration Management
|
||||
<img width="1944" height="1544" alt="CC Mate Configuration Interface" src="https://github.com/user-attachments/assets/a0222a76-2ba0-4fdb-89bc-7f0d49efed5a" />
|
||||
|
||||
### Usage Analytics
|
||||
<img width="1944" height="1544" alt="CC Mate Analytics Dashboard" src="https://github.com/user-attachments/assets/fa4f34f3-d1eb-4dc8-b7c3-3e703613c42a" />
|
||||
- **Title**: _TODO: add title_
|
||||
- **Description**: _TODO: add description_
|
||||
|
||||
|
||||
|
||||
<details>
|
||||
<summary><strong>All Screenshot</strong></summary>
|
||||
|
||||
- **Title**: _TODO: add title_
|
||||
- **Description**: _TODO: add description_
|
||||
|
||||
|
||||
|
||||
- **Title**: _TODO: add title_
|
||||
- **Description**: _TODO: add description_
|
||||
|
||||
|
||||
|
||||
- **Title**: _TODO: add title_
|
||||
- **Description**: _TODO: add description_
|
||||
|
||||
|
||||
|
||||
- **Title**: _TODO: add title_
|
||||
- **Description**: _TODO: add description_
|
||||
|
||||
|
||||
|
||||
- **Title**: _TODO: add title_
|
||||
- **Description**: _TODO: add description_
|
||||
|
||||
|
||||
|
||||
- **Title**: _TODO: add title_
|
||||
- **Description**: _TODO: add description_
|
||||
|
||||
|
||||
|
||||
- **Title**: _TODO: add title_
|
||||
- **Description**: _TODO: add description_
|
||||
|
||||
|
||||
|
||||
- **Title**: _TODO: add title_
|
||||
- **Description**: _TODO: add description_
|
||||
|
||||
|
||||
|
||||
- **Title**: _TODO: add title_
|
||||
- **Description**: _TODO: add description_
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
## ✨ Features
|
||||
|
||||
- **🔄 Multi-Configuration Support** - Switch between multiple Claude Code configurations effortlessly
|
||||
- **⚙️ MCP Server Management** - Configure and manage Model Context Protocol (MCP) servers
|
||||
- **🤖 Agent Management** - Manage Claude Code agents and their settings
|
||||
- **📋 Global Commands** - Configure and organize global commands
|
||||
- **📝 CLAUDE.md Integration** - Read and write global CLAUDE.md memory files
|
||||
- **🔔 Notifications**
|
||||
- **📊 Usage Analytics** - Track and analyze your Claude Code usage
|
||||
- **Multi-configuration support**: Switch between multiple Claude Code configurations effortlessly
|
||||
- **MCP server management**: Configure and manage Model Context Protocol (MCP) servers
|
||||
- **Agent management**: Manage Claude Code agents and their settings
|
||||
- **Global commands**: Configure and organize global commands
|
||||
- **Skills**: Define and manage reusable skills for Claude Code and MCP servers
|
||||
- **Plugins**: Configure and control external plugins and integrations
|
||||
- **Marketplace**: Discover, install, and manage community skills, plugins, and packs
|
||||
- **Commands**: Create and manage reusable command workflows for common tasks
|
||||
- **Hooks**: Attach automation hooks to Claude Code and MCP events
|
||||
- **Security packs**: Ready‑to‑use bundles of security agents, commands, skills, and configurations
|
||||
- **CLAUDE.md integration**: Read and write global CLAUDE.md memory files
|
||||
- **Usage analytics**: Track and analyze your Claude Code usage
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### Install with Homebrew (macOS)
|
||||
<!-- ## 🐳 Build with Docker
|
||||
|
||||
You can create a Linux (x86_64) release build inside a Docker container using the provided `Dockerfile`:
|
||||
|
||||
```bash
|
||||
# Add the tap and install CC Mate
|
||||
brew tap djyde/brew
|
||||
brew install --cask ccmate
|
||||
# Build the image (Linux x86_64 target by default)
|
||||
docker build -t ccmate-builder .
|
||||
|
||||
# Or install in one command
|
||||
brew install --cask djyde/brew/ccmate
|
||||
# Create a temporary container from the image
|
||||
docker create --name ccmate-out ccmate-builder
|
||||
|
||||
# Copy artifacts (AppImage / deb / other bundles) to ./dist
|
||||
docker cp ccmate-out:/artifacts ./dist
|
||||
|
||||
# Clean up the temporary container
|
||||
docker rm ccmate-out
|
||||
``` -->
|
||||
|
||||
### Build on macOS
|
||||
|
||||
First, install the toolchain:
|
||||
|
||||
```bash
|
||||
# Linux/MacOs
|
||||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
||||
|
||||
# Install pnpm (JavaScript package manager)
|
||||
## POSIX systems
|
||||
curl -fsSL https://get.pnpm.io/install.sh | env PNPM_VERSION=10.28.2 sh -
|
||||
```
|
||||
|
||||
### Download & Install
|
||||
Then run the build:
|
||||
|
||||
1. **Download the latest release** from [randynamic.org/ccmate](https://randynamic.org/ccmate)
|
||||
2. **Install the application** for your platform:
|
||||
- **macOS**: Download the `.dmg` file and drag to Applications
|
||||
- **Windows**: Download the `.exe` installer and run it
|
||||
- **Linux**: Download the `.AppImage` or `.deb` package
|
||||
3. **Launch CC Mate** from your applications folder
|
||||
```bash
|
||||
pnpm install
|
||||
rustup target add aarch64-apple-darwin x86_64-apple-darwin
|
||||
pnpm tauri build
|
||||
```
|
||||
|
||||
## 🤝 Contributing
|
||||
Artifacts will be under:
|
||||
|
||||
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on:
|
||||
|
||||
- Setting up the development environment
|
||||
- Building and testing the application
|
||||
- Code style and guidelines
|
||||
- Submitting pull requests
|
||||
|
||||
## 🐛 Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
**Application won't start**
|
||||
- Check if you have the latest version installed
|
||||
- Verify system requirements are met
|
||||
- Try running from terminal to see error messages
|
||||
|
||||
**Configurations not loading**
|
||||
- Ensure Claude Code is installed and has been run at least once
|
||||
- Check file permissions in `~/.claude/` directory
|
||||
- Verify backup files weren't corrupted
|
||||
|
||||
### Getting Help
|
||||
|
||||
- 📖 [Documentation](https://github.com/djyde/ccmate/wiki)
|
||||
- 🐛 [Report Issues](https://github.com/djyde/ccmate/issues)
|
||||
- 💬 [Discussions](https://github.com/djyde/ccmate/discussions)
|
||||
- 📋 [Contributing Guide](CONTRIBUTING.md)
|
||||
- `src-tauri/target/*/release/bundle/`
|
||||
|
||||
## 📄 License
|
||||
|
||||
@@ -97,12 +134,7 @@ This project is licensed under the **GNU Affero General Public License v3.0**.
|
||||
|
||||
See the [LICENSE](LICENSE) file for details.
|
||||
|
||||
---
|
||||
## Attribution
|
||||
|
||||
<div align="center">
|
||||
|
||||
**Made with ❤️ by the community**
|
||||
|
||||
[⭐ Star this repo](https://github.com/djyde/ccmate) • [🐦 Follow updates](https://github.com/djyde/ccmate/releases)
|
||||
|
||||
</div>
|
||||
Claude Samurai is based on the open‑source project [CC Mate](https://github.com/djyde/ccmate) created by djyde.
|
||||
Original work is licensed under the GNU Affero General Public License v3.0 (AGPLv3), and this project continues under the same license.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 129 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 191 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 136 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 150 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 158 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 131 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 172 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 143 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 184 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 182 KiB |
@@ -2,7 +2,7 @@
|
||||
"$schema": "https://schema.tauri.app/config/2",
|
||||
"productName": "Claude Samurai",
|
||||
"version": "1.0.0",
|
||||
"identifier": "org.randynamic.ccconfig",
|
||||
"identifier": "com.mfakbar127.claudesamurai",
|
||||
"build": {
|
||||
"beforeDevCommand": "pnpm dev",
|
||||
"devUrl": "http://localhost:1420",
|
||||
|
||||
@@ -4,7 +4,7 @@ import { DownloadIcon, ExternalLinkIcon, RotateCwIcon } from "lucide-react";
|
||||
import { useTheme } from "next-themes";
|
||||
import { useEffect, useState } from "react";
|
||||
import { useTranslation } from "react-i18next";
|
||||
import { FaXTwitter } from "react-icons/fa6";
|
||||
import { FaXTwitter, FaLinkedin } from "react-icons/fa6";
|
||||
import { Button } from "@/components/ui/button";
|
||||
import {
|
||||
Select,
|
||||
@@ -141,7 +141,7 @@ export function SettingsPage() {
|
||||
<div className="flex items-center gap-2">
|
||||
<Button
|
||||
onClick={(_) => {
|
||||
openUrl("https://github.com/djyde/ccmate-release/issues");
|
||||
openUrl("https://github.com/mfakbar127/Claude-Samurai/issues");
|
||||
}}
|
||||
variant="outline"
|
||||
size="sm"
|
||||
@@ -153,13 +153,13 @@ export function SettingsPage() {
|
||||
|
||||
<Button
|
||||
onClick={(_) => {
|
||||
openUrl("https://x.com/randyloop");
|
||||
openUrl("https://www.linkedin.com/in/mf-akbar/");
|
||||
}}
|
||||
variant="ghost"
|
||||
size="sm"
|
||||
className="text-sm"
|
||||
>
|
||||
<FaXTwitter />
|
||||
<FaLinkedin />
|
||||
</Button>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user