# ClashTui

![Demo](https://github.com/user-attachments/assets/7a35f4a7-e400-4e73-b2ec-0d68f287b99c)

Language: [English](./README.md) | [中文](./README_ZH.md)

## Table of Contents

<details>
<summary>Table of Contents</summary>
<!-- vim-markdown-toc GFM -->

* [Supported Platforms](#supported-platforms)
* [Target Audience](#target-audience)
* [Install](#install)
* [ClashTUI Usage](#clashtui-usage)
* [Uninstall](#uninstall)
* [See more](#see-more)
* [Trying new things](#trying-new-things)
* [Project Disclaimer](#project-disclaimer)

<!-- vim-markdown-toc -->
</details>

## Supported Platforms

- Linux
- Windows. Please refer to [Windows README](https://github.com/JohanChane/clashtui/blob/win/README.md)

## Target Audience

- Those with a certain understanding of Clash configurations.
- Fans of TUI software.

## Install

```sh
# Optional. sudo pacman -S mihomo clashtui
bash -c "$(curl -fsSL https://raw.githubusercontent.com/JohanChane/clashtui/refs/heads/main/install)"
# Optional. sudo systemctl enable clashtui_mihomo
```

If you want to install manually. See [Install Manually](./Doc/install_clashtui_manually.md)

## ClashTUI Usage

See [clashtui_usage](./Doc/clashtui_usage.md)

## Uninstall

```sh
curl -o /tmp/install https://raw.githubusercontent.com/JohanChane/clashtui/refs/heads/main/install
bash /tmp/install -u
```

## See more

[Doc](./Doc)

## Trying new things

- [dev](https://github.com/JohanChane/clashtui/tree/dev)
- [clashcli](https://github.com/JohanChane/clashtui/tree/aio)

## Project Disclaimer

This project is for learning and reference purposes only. The author does not guarantee the accuracy, completeness, or applicability of the code in the project. Users should use the code in this project at their own risk.

The author is not responsible for any direct or indirect losses caused by the use of the code in this project, including but not limited to data loss, computer damage, and business interruption.

Before using the code in this project, users should fully understand its functionality and potential risks, and seek professional advice if necessary. The author is not liable for any consequences resulting from the use of the code in this project.

When using the code in this project, please comply with relevant laws and regulations, and refrain from using it for illegal activities or activities that infringe upon the rights of others.

The author reserves the right of final interpretation of this disclaimer, and may modify and update it at any time.