Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

gs: fioctl: Add how to test configuration #584

Merged
merged 1 commit into from
Aug 15, 2023
Merged

gs: fioctl: Add how to test configuration #584

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 18 additions & 7 deletions source/getting-started/install-fioctl/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ We use `Github Releases`_ to distribute static golang binaries.
.. tabs::

.. group-tab:: Linux

.. attention::
Make sure you have ``curl`` installed.

Expand All @@ -60,7 +60,7 @@ We use `Github Releases`_ to distribute static golang binaries.
host:~$ sudo chmod +x /usr/local/bin/fioctl

.. group-tab:: macOS

.. attention::
Make sure you have ``curl`` installed.

Expand All @@ -77,9 +77,9 @@ We use `Github Releases`_ to distribute static golang binaries.
.. prompt:: bash host:~$, auto

host:~$ sudo curl -o /usr/local/bin/fioctl -L https://github.com/foundriesio/fioctl/releases/download/$FIOCTL_VERSION/fioctl-darwin-amd64

.. important::

For MacOS running on a Apple M1 processor, replace ``fioctl-darwin-amd64`` with ``fioctl-darwin-arm64``, and set ``FIOCTL_VERSION`` to v0.21 or newer.

2. Make the :ref:`ref-fioctl` binary executable:
Expand Down Expand Up @@ -122,7 +122,7 @@ For this, you will generate OAuth2 application credentials for interacting with
https://app.foundries.io/settings/credentials/

and create a new "Application Credential" to provide inputs below.

Client ID:

:ref:`ref-fioctl` will now ask for your Client ID and Secret. Follow the next steps to generate them.
Expand Down Expand Up @@ -161,7 +161,7 @@ Use the Client ID and Secret to finish the Fioctl login.
:width: 500
:align: center

Client ID and Secret
Client ID and Secret

.. prompt:: bash host:~$, auto

Expand All @@ -171,11 +171,22 @@ Use the Client ID and Secret to finish the Fioctl login.
https://app.foundries.io/settings/credentials/

and create a new "Application Credential" to provide inputs below.

Client ID:
Client secret:
You are now logged in to Foundries.io services.

The following command can be used to test the ``fioctl`` configuration.

.. prompt:: bash host:~$, auto

host:~$ fioctl -f <factory> status
Total number of devices: 0
TAG LATEST TARGET DEVICES ON LATEST ONLINE
--- ------------- ------- --------- ------

Orphan target versions below are marked with a star (*)

.. seealso::
:ref:`ref-fioctl` documentation.

Expand Down