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)

openwrt
Searching Database…

13.6K ·GitHub
ShellCrash
What is this?ShellCrash is a Shell script for deploying and managing mihomo/sing-box proxy client kernels on Linux-based devices — routers, servers, Docker — via a terminal management interface.
So is ShellCrash the proxy itself, or the manager for one?It's a manager, not the proxy engine: the script installs, switches and maintains the mihomo or sing-box kernel that actually handles traffic forwarding.
How do I install it on my router or server?SSH in as root, then run the one-line installer: wget from the jsDelivr CDN or curl from the author's source; router variants can pull from GitHub, jsDelivr or the author's private mirror.
What does my device need to have installed first?curl or wget is mandatory, and iptables or nftables is critical — without those the script can only run in Pure Mode. net-tools and ubus are optional nice-to-haves.
What usually trips people up during installation?Connection or SSL failures during install are expected enough that the README says to switch mirrors; devices with very old wget versions must use the author's private HTTP beta source instead.
What devices can it run on — is it routers only?Any Linux-kernel device: OpenWrt-style routers (Xiaomi, Netgear), Debian/CentOS/Armbian/Ubuntu servers, Padavan, Pandora and ASUS/Merlin firmware, busybox systems, or Docker on NAS like Synology.
How do I control it day to day?After install, a single terminal command opens the management interface. You can also install a local web dashboard that visualizes built-in rules and traffic.
Will it keep my subscription configs up to date on their own?Yes — scheduled tasks can auto-update your configuration files and rules (crontab required), and the script itself has built-in online self-update.
Can I install it on a device with no internet access?Yes — if online installation is not possible, there is a separate local installation tutorial on the author's blog for a manual setup.
Which traffic forwarding modes does it support?Several switchable ones, including Router mode (traffic passing through the device, e.g. a router serving a network) and Local mode (just the device itself).
What are similar projects?smartdns, 3X-UI_KIT, TikTokDownloader, brook, acme.sh, reinstall, haoel.github.io, vk-turn-proxy
Which topics is it in?alpine-linux, openwrt, webui, shell, proxy, utility, gplv3, networking, free, terminal, chinese, automation
Creator
juewuy
Size
5.1 GB
Stars
13.6K
Updated
CommitAug 27Release1.9.4Feb 15
Age
6y
Commits · 90 Days