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 status Show the NSSM service status, active profile, profile path, and installed sing-box.exe path.
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.6.tar.gz (170.4 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.6-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sing_cli-0.1.6.tar.gz
  • Upload date:
  • Size: 170.4 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.6.tar.gz
Algorithm Hash digest
SHA256 320d6ee962dee4f9bd8f1d8f3aad4575fb29f4b9007c0b8c9be63c54cafd90a6
MD5 5909b349ca66364b08aba1ce87c0a980
BLAKE2b-256 371debf732763c53951bbc1b089b815c73a0a924ec6829a6ad1dae99495b3eda

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sing_cli-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 7.8 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 97dc744588393df7c7e7bea07949f767ea6792d8d2f3956ef63df5a3185c7e35
MD5 2bcc29333bdc19e52c8688c3a85767d0
BLAKE2b-256 963567a2da90fab997db603ef3a7f332a7b9c9c881d3c6bbc32f78327541fc3b

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