ShellCrash README

The project's README from github.com/juewuy/ShellCrash. As one markdown file: README.md.

ShellCrash

A powerful script tool for the convenient deployment and management of mihomo/sing-box kernels in Shell environments.

简体中文 | English


:rocket: Core Features

:computer: Device Support

ShellCrash is designed to be compatible with the vast majority of network devices based on the Linux kernel:

For additional device support, please submit an Issue or provide feedback in the Telegram Group (please include the device model and the output of the uname -a command).


:hammer_and_wrench: Installation Guide

[!TIP] If you encounter connection failures or SSL-related issues, please try switching to an alternative installation mirror.

Prerequisites

  1. Ensure the device has SSH enabled and Root privileges obtained (Linux systems with a GUI can use the terminal directly).
  2. Connect to the device using an SSH tool (such as PuTTY, JuiceSSH, or the system's built-in terminal).

:penguin: Standard Linux Device Installation

[!IMPORTANT] Please perform the installation as the root user.

Install via wget (jsDelivr CDN source)

export url='https://testingcf.jsdelivr.net/gh/juewuy/ShellCrash@dev' \
  && wget -q --no-check-certificate -O /tmp/install.sh $url/install_en.sh \
  && bash /tmp/install.sh \
  && . /etc/profile &> /dev/null

Or install via curl (Author's private source)

export url='https://gh.jwsc.eu.org/dev' && bash -c "$(curl -kfsSl $url/install_en.sh)" && . /etc/profile &> /dev/null

:satellite: Router Device Installation

Installation via curl:

GitHub Source (Recommended for overseas environments or environments with proxy access)

export url='https://raw.githubusercontent.com/juewuy/ShellCrash/dev' \
  && sh -c "$(curl -kfsSl $url/install_en.sh)" \
  && . /etc/profile &> /dev/null

Or jsDelivr CDN source

export url='https://testingcf.jsdelivr.net/gh/juewuy/ShellCrash@dev' \
  && sh -c "$(curl -kfsSl $url/install_en.sh)" \
  && . /etc/profile &> /dev/null

Or Author's private source

export url='https://gh.jwsc.eu.org/dev' && sh -c "$(curl -kfsSl $url/install_en.sh)" && . /etc/profile &> /dev/null

Installation via wget:

GitHub Source (Recommended for overseas environments or environments with proxy access)

export url='https://raw.githubusercontent.com/juewuy/ShellCrash/dev' \
  && wget -q --no-check-certificate -O /tmp/install.sh $url/install_en.sh \
  && sh /tmp/install.sh \
  && . /etc/profile &> /dev/null

Or jsDelivr CDN source

export url='https://testingcf.jsdelivr.net/gh/juewuy/ShellCrash@dev' \
  && wget -q --no-check-certificate -O /tmp/install.sh $url/install_en.sh \
  && sh /tmp/install.sh \
  && . /etc/profile &> /dev/null

:pager: Installation for Legacy Devices with Older wget Versions

Author's private HTTP beta source

export url='http://t.jwsc.eu.org' \
  && wget -q -O /tmp/install.sh $url/install_en.sh \
  && sh /tmp/install.sh \
  && . /etc/profile &> /dev/null

:cloud: Virtual Machines

# Install necessary dependencies
apk add --no-cache wget openrc ca-certificates tzdata nftables iproute2 dcron
# Execute installation command
export url='https://testingcf.jsdelivr.net/gh/juewuy/ShellCrash@dev' \
  && wget -q --no-check-certificate -O /tmp/install.sh $url/install_en.sh \
  && sh /tmp/install.sh \
  && . /etc/profile &> /dev/null

:whale: Docker

Please visit the official Docker image:

:package: Local Installation

If online installation is not possible, please follow the guide for local installation:


:book: Usage Instructions

After installation, enter the following commands in the terminal to launch the management interface:

crash        # Launch the interactive script menu
crash -h     # View the list of command help

Running Dependencies

Component Necessity Description
curl / wget Mandatory Required for node saving, online installation, and update operations.
iptables / nftables Critical Without these, the script can only run in Pure Mode.
crontab Low Required for scheduled tasks; otherwise, they will not function.
net-tools Very Low Used for automatic port occupancy detection.
ubus / iproute-doc Very Low Used for automatically obtaining the local Host address.

:scroll: License

This project is licensed under the GNU General Public License v3.0.

ShellCrash (juewuy/ShellCrash)

Searching Database…

这是干什么的?ShellCrash 是一个 Shell 脚本,用于在基于 Linux 的设备(路由器、服务器、Docker)上部署和管理 mihomo/sing-box 代理客户端内核,通过终端管理界面进行操作。
那 ShellCrash 本身是代理,还是代理的管理工具?它是一个管理工具,而不是代理引擎:这个脚本负责安装、切换和维护真正处理流量转发的 mihomo 或 sing-box 内核。
怎么把它装到我的路由器或服务器上?以 root 身份 SSH 登录,然后运行一行安装命令:用 wget 从 jsDelivr CDN 下载,或用 curl 从作者源下载;路由器版本还可以从 GitHub、jsDelivr 或作者的私人镜像拉取。
我的设备需要先装好哪些东西?curl 或 wget 是必需的,iptables 或 nftables 也至关重要——没有它们,脚本只能以纯净模式(Pure Mode)运行。net-tools 和 ubus 是可选的锦上添花项。
安装时大家一般会在哪里踩坑?安装过程中出现连接或 SSL 失败很常见,README 都建议直接换镜像源;wget 版本非常老的设备必须改用作者的私人 HTTP beta 源。
它能跑在哪些设备上——只有路由器吗?任何 Linux 内核的设备都可以:OpenWrt 类路由器(小米、Netgear)、Debian/CentOS/Armbian/Ubuntu 服务器、Padavan、Pandora 和华硕/Merlin 固件、busybox 系统,以及群晖等 NAS 上的 Docker。
日常使用时我怎么操作它?安装完成后,一条终端命令就能打开管理界面。你还可以安装一个本地 Web 面板,将内置规则和流量可视化展示。
它能自动保持我的订阅配置最新吗?可以——定时任务可以自动更新你的配置文件和规则(需要 crontab),脚本本身也内置了在线自我更新功能。
没有联网的设备也能装吗?可以——如果无法在线安装,作者博客上有单独的本地安装教程,可以手动完成部署。
它支持哪些流量转发模式?支持几种可切换的模式,包括路由模式(转发经过该设备的流量,例如为整个网络服务的路由器)和本机模式(仅限设备自身)。
Creator
juewuy
Size
5.1 GB
Stars
13.6K
Age
6y
Commits · 90 Days