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.4.tar.gz (167.0 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.4-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sing_cli-0.1.4.tar.gz
  • Upload date:
  • Size: 167.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.15 {"installer":{"name":"uv","version":"0.11.15","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.4.tar.gz
Algorithm Hash digest
SHA256 f06a6712c9e07437339bb3896631c564af99e6baeb6553a0f96c9903e25c1c4f
MD5 3d81225374f876449976fba5956f9da4
BLAKE2b-256 edf35fa7477e470ecd4fb1119628008d3f9b7cd14a051552e24a043999b86a14

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sing_cli-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 7.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.15 {"installer":{"name":"uv","version":"0.11.15","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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 a112d5aa0ca1bc0c6197800a00c257c83889525c2fddcd8ca5b574790e7135e8
MD5 68dd7a0e18fb96f7ed0661949760c879
BLAKE2b-256 f986c6465914b1295d2ec35548f7126c65a276891fa1b17013e005fdc32a93a5

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