# Command-Line Help for `clash-cli`

This document contains the help content for the `clash-cli` command-line program.

**Command Overview:**

- [`clash-cli`↴](#clash-cli)
- [`clash-cli completions`↴](#clash-cli-completions)
- [`clash-cli dashboard`↴](#clash-cli-dashboard)
- [`clash-cli docs`↴](#clash-cli-docs)
- [`clash-cli docs markdown`↴](#clash-cli-docs-markdown)
- [`clash-cli subscription`↴](#clash-cli-subscription)
- [`clash-cli subscription list`↴](#clash-cli-subscription-list)
- [`clash-cli subscription update`↴](#clash-cli-subscription-update)

## `clash-cli`

CLI for clash

**Usage:** `clash-cli <COMMAND>`

###### **Subcommands:**

- `completions` — Generate tab-completion scripts for your shell
- `dashboard` — Open Clash Dashboard
- `docs` — Generate docs for this CLI
- `subscription` — CLI for clash

## `clash-cli completions`

Generate tab-completion scripts for your shell

**Usage:** `clash-cli completions <SHELL>`

###### **Arguments:**

- `<SHELL>`

  Possible values: `bash`, `elvish`, `fish`, `powershell`, `zsh`

## `clash-cli dashboard`

Open Clash Dashboard

**Usage:** `clash-cli dashboard [OPTIONS]`

###### **Options:**

- `-f`, `--file <FILE>` — [default: $HOME/.config/clash/config.yaml]
- `--hostname <HOSTNAME>`
- `-p`, `--port <PORT>`
- `-s`, `--secret <SECRET>`

## `clash-cli docs`

Generate docs for this CLI

**Usage:** `clash-cli docs <COMMAND>`

###### **Subcommands:**

- `markdown` — Generate markdown docs for this CLI

## `clash-cli docs markdown`

Generate markdown docs for this CLI

**Usage:** `clash-cli docs markdown`

## `clash-cli subscription`

CLI for clash

**Usage:** `clash-cli subscription <COMMAND>`

###### **Subcommands:**

- `list` — List Clash subscriptions
- `update` — Update Clash subscription

## `clash-cli subscription list`

List Clash subscriptions

**Usage:** `clash-cli subscription list [OPTIONS]`

###### **Options:**

- `--folder <FOLDER>` — Bitwarden folder name

  Default value: `the Great Wall`

- `--show-url` — Show subscription URL instead of UserInfo

## `clash-cli subscription update`

Update Clash subscription

**Usage:** `clash-cli subscription update [OPTIONS] <NAME>`

###### **Arguments:**

- `<NAME>` — subscription name

###### **Options:**

- `-f`, `--file <FILE>` — Clash config filepath [default: $HOME/.config/clash/config.yaml]
- `--folder <FOLDER>` — Bitwarden folder name

  Default value: `the Great Wall`

- `-s`, `--secret <SECRET>` — Clash secret [default: bw get notes CLASH_SECRET]

<hr/>

<small><i>
This document was generated automatically by
<a href="https://crates.io/crates/clap-markdown"><code>clap-markdown</code></a>.
</i></small>