Skip to main content

Add your description here

Project description

sing-cli

Windows CLI for installing and controlling the sing-box Windows service.

Requirements

sing-box.exe and nssm.exe must be available in PATH. sing install --bin <path> can use a custom sing-box.exe path.

On Windows, install the runtime executables with Scoop:

scoop install sing-box nssm

Installation

Install sing-cli:

uv tool install sing-cli

Update sing-cli:

uv tool upgrade sing-cli

Uninstall sing-cli:

uv tool uninstall sing-cli

Commands

Command Description
sing install [--bin <path>] Register the sing-box Windows service through NSSM and enable autostart.
sing uninstall Delete the sing-box Windows service.
sing start <name> Start the service with a saved profile.
sing stop Stop the service.
sing restart Stop, reconfigure, and start the service with the active profile.
sing add <name> <url> Download a complete sing-box JSON profile and save it under a name.
sing remove <name> Remove a saved non-active profile.
sing update <name> Redownload a saved profile from its URL.
sing list List saved profiles and mark the active profile.

sing install uses sing-box.exe from PATH unless --bin is provided. The CLI does not download or upgrade sing-box.exe or nssm.exe.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sing_cli-0.1.3.tar.gz (151.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sing_cli-0.1.3-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file sing_cli-0.1.3.tar.gz.

File metadata

  • Download URL: sing_cli-0.1.3.tar.gz
  • Upload date:
  • Size: 151.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for sing_cli-0.1.3.tar.gz
Algorithm Hash digest
SHA256 690d0ac3ae5f749d94d7687afb58695a6c4df0f81f5a4ef51aa9867222812ad6
MD5 180462386863dff39799fd4b02612e45
BLAKE2b-256 845d710a59c319bd8b1a23a6ef9fd7e515cc84a9897266c94e52995e795c3949

See more details on using hashes here.

File details

Details for the file sing_cli-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: sing_cli-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for sing_cli-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d59835d02284462ed8a802ea5b34317b905c4708724e5721d049315bb80551dd
MD5 f18c21b6db0495e9ecd3e4bdc346d679
BLAKE2b-256 3a75b48693a657377c6eff5a599d93485be0b633c20e11f333d7ee3380d91383

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page