Skip to content

Commit

Permalink
Improve introduction of fioctl guide
Browse files Browse the repository at this point in the history
Added links and reworked page summary for Fioctl.

QA Steps: viewed HTML in browser and ran linter.
Linter warnings can be ignored.
Only expected inkcheck errors found.

This commit addresses Jira FFTK-990, "Improve intro to fioctl"

Signed-off-by: Katrina Prosise <[email protected]>
  • Loading branch information
kprosise committed Jan 13, 2025
1 parent 2c0134e commit a3d9069
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions source/user-guide/fioctl/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,24 @@
Fioctl
======

This section provides details on using :ref:`Fioctl® <ref-fioctl>` by way of example.
Fioctl is an Open Source CLI tool for managing your Factory by providing a way to interact with the FoundriesFactory REST API.

Prerequisites
-------------
.. tip::
Fioctl releases happen independently of LmP releases.

* Completion of the getting started guide.
* :ref:`Installing Fioctl <gs-install-fioctl>`
* :ref:`Fioctl reference manual <ref-fioctl>`
* `Fioctl source <https://github.com/foundriesio/fioctl>`_

Below you will find examples of common tasks and commands.

.. _ug-fioctl-auto-update:

Auto Updating
-------------

``fioctl version --update-to <version>``
Fioctl v0.36 and later can be updated—rather securely, via TUF—without the need to manually reinstall the binary.
Fioctl can be updated—securely via TUF—without needing to manually reinstall the binary.

.. code-block:: console
Expand Down

0 comments on commit a3d9069

Please sign in to comment.