ss/README.md

# Scientific Surfing

A CLI for surfing the internet scientifically, written in Go.

## Features

- **Clash RSS Subscription Support**: Download and transform clash rss subscriptions
- **Hook System**: Customizable scripts for extending functionality
- **Core Configuration Management**: Import, export, and manage core configurations
- **Binary Management**: Automatic updates for core (mihomo) components
- **Service Management**: Install/start/stop/reload mihomo as a system service on Linux (systemd), macOS (launchd), and Windows (native Service Control Manager)

## Installation

### 1. Clone and build

```bash
git clone ssh://git@gitea.epss.net.cn:2223/klesh/ss.git
cd ss
make build
```

This produces a single `ssm` (or `ssm.exe` on Windows) binary with no runtime dependencies — templates and hook scripts are embedded in the binary.

### 2. Add the binary to your system PATH

## Quick Start

### Subscription Management
```bash
# add a subscription
ssm subscription add <name> <clash-rss-subscription-url>

# refresh a subscription (with optional backup)
ssm subscription refresh <name> [--backup]

# delete a subscription
ssm subscription rm <name>

# rename a subscription
ssm subscription rename <name> <new-name>

# update subscription URL
ssm subscription set-url <name> <new-url>

# show the URL for a subscription
ssm subscription get-url <name>

# activate a subscription (additive — other active subscriptions stay active)
ssm subscription activate <name>

# deactivate a subscription
ssm subscription deactivate <name>

# list all subscriptions
ssm subscription list

# show storage information
ssm subscription storage
```

More than one subscription can be active at the same time — `config apply` merges the proxies (and any proxy-groups a subscription bundles, like an "Auto"/"Proxy" group) from every active subscription into the generated config, prefixing each proxy and proxy-group name with its source subscription's name (e.g. `home-sub | HK 01`) so identically-named ones from different subscriptions don't collide. Any reference to a renamed proxy/group within that subscription's own groups *or* rules (e.g. `DOMAIN,example.com,Proxy`, `MATCH,Auto`) is rewritten to match, so nothing ends up pointing at a name that no longer exists.

### Hook Management
```bash
# initialize hooks directory with template scripts
ssm hook init

# show hooks directory location and list all scripts
ssm hook list

# edit a hook script with system editor
ssm hook edit <script-name>

# remove a hook script
ssm hook rm <script-name>
```

### Core Configuration Management
```bash
# import configuration from file
ssm config import <file-path> [--config-file <config.yaml>]

# export configuration to file
ssm config export <file-path> [--config-file <config.yaml>]

# edit configuration with system editor
ssm config edit [--config-file <config.yaml>]

# reset configuration to default values
ssm config reset [--config-file <config.yaml>]

# show current configuration
ssm config show [--config-file <config.yaml>]

# apply subscription to generate final config (with advanced options)
ssm config apply \
	[--config-file <config.yaml>] \
	[--output-file <output.yaml>] \
	[--subscription <subscription-name>]
```
**Options** (available on every `ssm config` subcommand):
- `--config-file <config.yaml>`: Use a custom config file instead of the default.
- `--output-file <output.yaml>`: Specify the output path for the generated config file.
- `--subscription <subscription-name>`: Use only this one specific subscription for config generation, overriding the active set entirely (even if multiple subscriptions are active).

### Automation (`ssm:` block in core-config.yaml)

`core-config.yaml` can carry an `ssm:` key — this tool's own automation config, applied when you run `config apply` and always stripped out of the generated config before it's written (mihomo never sees it). It supports three things:

1. **`proxy-groups`** — build a new proxy-group from proxies matching a subscription and/or keyword filter.
2. **`rate-filters`** — build a new proxy-group from proxies whose name encodes a rate/multiplier (e.g. `HK 01 | 1.5x`), extracted via a regexp and compared against a threshold.
3. **`patches`** — append/prepend/replace an arbitrary value at any path in the generated config.

```yaml
ssm:
  proxy-groups:
    - name: "HK Nodes"
      type: select                     # any extra clash proxy-group fields (url, interval, tolerance...) pass through as-is
      match:
        subscriptions: ["home-sub"]    # optional; omit to match proxies from any subscription
        name-contains: ["HK", "Hong Kong"]  # optional; OR-matched, case-insensitive, matched against the proxy's original (pre-prefix) name

  rate-filters:
    - name: "Cheap Nodes"
      type: select
      pattern: '([\d.]+)x'             # regexp; its first capture group is parsed as the rate
      operator: "<="                   # one of <, <=, >, >=, ==, !=
      value: 1.0                       # proxies whose name doesn't match `pattern` at all are excluded
      match:
        subscriptions: ["home-sub", "work-sub"]

  patches:
    - path: dns.nameserver             # dot/bracket path: dots descend into maps, [N] indexes into lists
      op: prepend                      # append | prepend | replace
      value: ["1.1.1.1"]
    - path: proxy-groups[0].proxies
      op: append
      value: ["DIRECT"]
    - path: rules
      op: replace
      value: ["MATCH,PROXY"]
```

`proxy-groups` and `rate-filters` run before `patches`, so patches can reference or further adjust the groups they created (e.g. `proxy-groups[-1]`-style indexing isn't supported — use the group's actual index, or patch `proxy-groups` itself with `append`/`prepend`).

### Core Management
```bash
# update mihomo core binary
ssm core update [--version <version>] [--force]
```

### Service Management
```bash
ssm service install [--name <name>] [--description <description>]
ssm service uninstall [--name <name>]
ssm service start [--name <name>]
ssm service stop [--name <name>]
ssm service restart [--name <name>]
ssm service reload [--name <name>]   # reload config via mihomo's API, no restart
ssm service status [--name <name>]
```

`install`/`uninstall`/`start`/`stop`/`restart` need root/admin privileges:

- **Linux / macOS**: just run the command directly — `ssm` re-execs itself under `sudo` automatically, prompting for your password if needed.
- **Windows**: run from an elevated/Administrator shell — `ssm.exe service install`.

## Development

```bash
make build   # build ssm for the current platform
make test    # go test ./...
make vet     # go vet ./...
make fmt     # check formatting (gofmt -l)
make help    # list all targets
```

### Releasing

```bash
make release VERSION=v1.0.0
```

Cross-compiles for linux/amd64, darwin/arm64, and windows/amd64, and packages each into `dist/` as a `.tar.gz`/`.zip` alongside a `checksums.txt`. Pushing a `vX.Y.Z` tag runs the same thing via `.drone.yml` and publishes the artifacts as a Gitea release.

## License

MIT License - see LICENSE file for details.