# Command-Line Help for `sing-box-cli`

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

**Command Overview:**

- [`sing-box-cli`↴](#sing-box-cli)
- [`sing-box-cli complete`↴](#sing-box-cli-complete)
- [`sing-box-cli ip`↴](#sing-box-cli-ip)
- [`sing-box-cli sub`↴](#sing-box-cli-sub)
- [`sing-box-cli sub list`↴](#sing-box-cli-sub-list)
- [`sing-box-cli sub update`↴](#sing-box-cli-sub-update)
- [`sing-box-cli sub url`↴](#sing-box-cli-sub-url)

## `sing-box-cli`

**Usage:** `sing-box-cli [OPTIONS] <COMMAND>`

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

- `complete` — Generate tab-completion scripts for your shell
- `ip` —
- `sub` —

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

- `-v`, `--verbose` — More output per occurrence
- `-q`, `--quiet` — Less output per occurrence

## `sing-box-cli complete`

Generate tab-completion scripts for your shell

```fish
$ sing-box-cli complete fish >$HOME/.local/share/fish/vendor_completions.d
$ sing-box-cli complete fish >/usr/local/share/fish/vendor_completions.d
```

**Usage:** `sing-box-cli complete <SHELL>`

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

- `<SHELL>`

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

## `sing-box-cli ip`

**Usage:** `sing-box-cli ip [OPTIONS]`

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

- `-t`, `--timeout <TIMEOUT>`

  Default value: `3`

## `sing-box-cli sub`

**Usage:** `sing-box-cli sub <COMMAND>`

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

- `list` —
- `update` —
- `url` —

## `sing-box-cli sub list`

**Usage:** `sing-box-cli sub list [OPTIONS] [NAME]...`

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

- `<NAME>`

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

- `-f`, `--field <FIELD>`

  Default values: `name`, `download`, `upload`, `total`, `expire`

  Possible values: `name`, `url`, `download`, `upload`, `total`, `expire`

- `--folder <FOLDER>`

  Default value: `the Great Wall`

## `sing-box-cli sub update`

**Usage:** `sing-box-cli sub update [OPTIONS] [NAME]...`

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

- `<NAME>`

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

- `-a`, `--api <API>`

  Default value: `https://sub.liblaf.me`

- `-c`, `--config <CONFIG>`

  Default value: `/etc/sing-box/config.json`

- `-f`, `--field <FIELD>`

  Default values: `name`, `download`, `upload`, `total`, `expire`

  Possible values: `name`, `url`, `download`, `upload`, `total`, `expire`

- `--folder <FOLDER>`

  Default value: `the Great Wall`

## `sing-box-cli sub url`

**Usage:** `sing-box-cli sub url [OPTIONS] [NAME]...`

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

- `<NAME>`

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

- `-a`, `--api <API>`

  Default value: `https://sub.liblaf.me`

- `--folder <FOLDER>`

  Default value: `the Great Wall`

<hr/>

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