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.2.tar.gz (145.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.2-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sing_cli-0.1.2.tar.gz
  • Upload date:
  • Size: 145.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.13 {"installer":{"name":"uv","version":"0.11.13","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.2.tar.gz
Algorithm Hash digest
SHA256 6c3e0bbb59dc05a77610998f1df481c64f21ada14e1a328bdaabb4dbaf12f9eb
MD5 8755ac0ee18c2ccc467325c0d512079c
BLAKE2b-256 cc8c5abaaffe2e4738248c0f81432ca77c1ed1f3cf7cce4b3b5d88f67dba3e9c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sing_cli-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.13 {"installer":{"name":"uv","version":"0.11.13","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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6d310f938e34d58eef22e7e0f4fd0716aeeaedd156a3620990be085bbfe0e12b
MD5 562786da65972e0dc06ffee3eb4be9ab
BLAKE2b-256 9ab3cc753ffbb1f8d6ccf581ef9a044c3cd5b5b5b6e0d23d6b7e1688506c8867

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