https://github.com/samunatsu/mihomosh
A CLI Toolkit for Mihomo
https://github.com/samunatsu/mihomosh
clash clash-meta cli mihomo rust
Last synced: about 2 months ago
JSON representation
A CLI Toolkit for Mihomo
- Host: GitHub
- URL: https://github.com/samunatsu/mihomosh
- Owner: SamuNatsu
- License: gpl-3.0
- Created: 2025-02-18T15:27:57.000Z (over 1 year ago)
- Default Branch: v1
- Last Pushed: 2025-08-02T09:00:39.000Z (11 months ago)
- Last Synced: 2025-08-02T09:49:59.582Z (11 months ago)
- Topics: clash, clash-meta, cli, mihomo, rust
- Language: Rust
- Homepage:
- Size: 220 KB
- Stars: 45
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mihomosh
A CLI Toolkit for Mihomo
> [!IMPORTANT]
> Mihomosh **DOES NOT** contain Mihomo distribution itself!
> It **IS** just a toolkit that works with Mihomo!
> If there is no Mihomo deployed on your machine, please deploy it first.
## Features
- Full featured remote/local profiles management
- Global-level/Profile-level extend configs and extend scripts support
- Basic but enough Mihomo controlling through RESTful API
- Basic Mihomo running status display
- Manual URL testing for activated profile
## Prerequisite
- Mihomosh relies on `vim` for fallback editing
- Mihomosh relies on `less` for showing some very long text
## Install
### Oneline Command (Unix-like ONLY)
```sh
curl -s https://installer.samunatsu.workers.dev/SamuNatsu/mihomosh | bash
```
### Cargo Install
Build and install Mihomosh locally
```sh
cargo install --git https://github.com/SamuNatsu/mihomosh.git
```
### Download from Releases
Latest version:
Please find the `.tar.gz`/`.zip` asset that fits your platform and architecture.
## Best Practices
### 1. If your Mihomo data directory needs root to access, please always run Mihomosh as root user (For Unix-like)
Mihomosh stores configs and data files under user directories (`/home/some_user` for non-root user, `/root` for root user).
If your Mihomo data directory needs root, but your Mihomosh configs are under non-root user directories, it would cause:
1. Permission denied (run Mihomosh as **non-root user**, you are not able to write the Mihomo configs for activating profiles)
2. File not found (run Mihomosh as **root user**, you are not able to find Mihomosh configs under root directories)
Therefore, you'd better always run Mihomosh as root user, Mihomosh configs and data files will be stored under root directories.
Neither permission denied nor file not found would happen.
If you've already stored your Mihomosh configs and data files under non-root user directories, you can find the folder in `/home/some_user/.local/share/mihomosh`, just move it to `/root/.local/share/mihomosh`, then change the owner and group.
## Usage
See [wiki](https://github.com/SamuNatsu/mihomosh/wiki). **(WIP)**