.. _command-system:

``./flow system``
=================

Synopsis
--------

.. code-block::

   $ ./flow system --format {props,platform,debug}

Description
-----------

This command provides :mod:`proj_flow.base.uname` data in a way, that is easy
to consume by various other tools. For instance, the ``.flow/packages/base.cmake``
file generated by :ref:`command-init` command uses ``system --format platform``
while deciding on the file name of packages produced by CPack.

``--format props``
    Print list of platform properties for `cov <https://github.com/mzdun/cov>`_.
    Currently, no tooling in *Project Flow* makes any use of this format.

``--format platform``
    Print the chunk of package file in form of ``<platform>[-<version>]-<arch>``.
    E.g. on latest LTS version of Ubuntu it may result

    .. code-block:: console

        $ ./flow system --format platform
        ubuntu-24.04-x86_64

    Or on any version of AMD64 Windows it will print

    .. code-block:: console

        $ ./flow system --format platform
        windows-x86_64

    When used to pack version "3.14.15" of a project named "tools", this may
    result in package files, such as ``tools-3.14.15-ubuntu-24.04-x86_64.tar.gz``
    or ``tools-3.14.15-windows-x86_64.zip``.

``--format debug``
    Print values returned by various :py:mod:`platform` functions, contrasted
    with values returned by :func:`uname`.

    .. code-block:: console

        $ ./flow system --format debug
        uname uname_result(system='Linux', node='DEV1', release=...
        machine x86_64
        node DEV1
        platform Linux-6.8.0-52-generic-x86_64-with-glibc2.35
        processor x86_64
        release 6.8.0-52-generic
        system Linux
        version #53~22.04.1-Ubuntu SMP ...
        -----
        node DEV1
        os ubuntu
        version 22.04
        machine x86_64