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.5.tar.gz (168.7 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.5-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sing_cli-0.1.5.tar.gz
  • Upload date:
  • Size: 168.7 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.5.tar.gz
Algorithm Hash digest
SHA256 4ea6c48d91dd6b4b89af61983e803ac6c62dc4aae7cfdc5c54b8c15f6a27fe60
MD5 4b96c8bda9135de551613b368b699925
BLAKE2b-256 d3ce6567d067b5746e86ab7cb5b99a689ece6495e089cdcbcc20aa6778403bd6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sing_cli-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 7.6 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 06b995f43689be176b99296786a983aeffba35a662ddc32cc4a0d7ef4dd04834
MD5 ab80dee41edc60032aeb76ecc94dc63b
BLAKE2b-256 83c0d524e9ad65b1e0c0d4516aff90c9f6b9ad734e327ff2dc1fde560bb250c3

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