sfdk-maintain

Launch SDK Maintenance tool

$ sfdk maintain

sfdk-maintain [global_options] command [command_options] [arguments]

update
    Checks for and installs updates for all installed Sailfish OS SDK components, including SDK tools, build engines, targets, and toolchains.

list [components|updates]
    Lists installed SDK components or available updates. Specify 'components' to see what's currently installed, or 'updates' to see what can be updated.

install <component_name>
    Installs a specified SDK component, such as a new build target (e.g., sailfishos-target-armv7hl), a toolchain, or an emulator.

remove <component_name>
    Removes an installed SDK component from the system. Use with caution as this may affect projects relying on the removed component.

doctor
    Runs a diagnostic check on the SDK installation, identifying potential issues or misconfigurations that might hinder development.

--help, -h
    Displays a brief help message with available commands and options for sfdk-maintain.

--version
    Shows the version information of the sfdk-maintain tool.

--verbose, -v
    Enables verbose output, providing more detailed information about the operations being performed.

--non-interactive
    Runs the command in non-interactive mode, suitable for scripting. It will not prompt for user input.

The sfdk-maintain command is a crucial utility within the Sailfish OS SDK, designed for managing and maintaining the SDK installation itself. It allows developers to perform various administrative tasks, ensuring the SDK components are up-to-date and correctly configured. This command-line tool simplifies the process of installing new build targets, toolchains, emulators, and other essential SDK components, as well as updating existing ones or removing them when no longer needed.

It interacts directly with the SDK's internal structure and component repositories, fetching and applying updates from official sources. Beyond component management, sfdk-maintain also provides diagnostic capabilities, helping users identify and resolve common issues that might arise within their SDK environment. It's an indispensable tool for anyone developing applications for Sailfish OS, ensuring a stable and functional development setup.

sfdk-maintain often requires an active internet connection to download and install updates or new components.
Some operations, especially installing or removing core SDK components, might require root privileges or running the command via sudo, depending on how the SDK was installed and configured.
Interrupting an update or installation process can leave the SDK in an inconsistent state, potentially requiring manual repair or reinstallation.

sfdk-maintain manages various types of components including:
Toolchains: Compilers and build tools for specific architectures.
Build Targets: Device-specific SDKs that include headers and libraries for different Sailfish OS versions and architectures.
Emulators: Virtual devices for testing applications without physical hardware.
SDK Tools: Core utilities and supporting applications for development.

This command is primarily used by developers working with Sailfish OS. It is typically invoked from the command line within the SDK's environment or from a terminal on the host system where the SDK is installed. Its functions are essential for setting up new development environments, keeping them current, and troubleshooting issues.

The sfdk-maintain command is an integral part of the Sailfish OS SDK, which is developed by Jolla Ltd. Its evolution is closely tied to the development of Sailfish OS itself and the SDK tools provided for developers. It was introduced as a robust command-line interface to manage the increasingly complex set of components required for Sailfish OS development, moving beyond simpler update scripts to a more unified and user-friendly maintenance utility.

sfdk(1), sdk-chroot(1), qmake(1)