Common features
This page describes the features that sing-box graphical clients implement uniformly.
Profiles
A profile describes a sing-box configuration and its state.
Local
- A local profile represents a local sing-box configuration with minimal state
- Graphical clients must provide an editor for modifying the content
iCloud (iOS and macOS only)
- An iCloud profile represents a remote sing-box configuration where iCloud acts as the update source
- Profiles are stored in the sing-box folder inside iCloud
- Graphical clients must provide an editor for modifying the content
Remote
- A remote profile represents a remote sing-box configuration where a URL acts as the update source
- Graphical clients should provide a viewer for the configuration content
- Graphical clients must implement automatic profile updates (default interval: 60 minutes) and HTTP basic authentication
Graphical clients must also support importing remote profiles through a dedicated URL scheme, defined as:
sing-box://import-remote-profile?url=urlEncodedURL#urlEncodedNameDashboard
While the sing-box service is running, graphical clients should provide a dashboard for managing it.
Status
The dashboard should display status information such as memory, connections and traffic.
Mode
The dashboard should provide a mode selector, for switching when the configuration uses at least two clash_mode values.
Groups
When the configuration contains grouped outbounds (especially Selector or URLTest), the dashboard should provide a group selector to show group status or switch between them.
Other
Core
Graphical clients should provide a core section that:
- Displays the current sing-box version
- Provides a button to clean the working directory
- Provides a memory limit toggle