Installing Fioctl¶

Fioctl™ is a simple tool for interacting with the Foundries.io REST API.

Installation¶

Manual Installation¶

We use Github Releases to distribute static golang binaries.

Tip

Repeating the following steps will overwrite an existing binary, useful for updating or changing version.

Attention

Make sure you have curl installed.

Download a Linux binary to a directory on your PATH.

For example, to download version v0.32.0 on Linux, define the version:

FIOCTL_VERSION="v0.32.0"

Download the binary with curl:

sudo curl -o /usr/local/bin/fioctl -LO https://github.com/foundriesio/fioctl/releases/download/$FIOCTL_VERSION/fioctl-linux-amd64

Make the Fioctl binary executable:
```
sudo chmod +x /usr/local/bin/fioctl
```

Attention

Make sure you have curl installed.

Download a Darwin binary from the Github Releases page to a directory on your PATH.

For example, to download version v0.32.0 on macOS, define the version:
```
FIOCTL_VERSION="v0.32.0"
```
Download the binary with curl:
```
curl -o /usr/local/bin/fioctl -LO 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.
Make the Fioctl binary executable:
```
sudo chmod +x /usr/local/bin/fioctl
```

Download a Windows binary from the Github Releases page.
Put it in a folder of your choosing and rename it to fioctl.exe
Press Win + R and type SystemPropertiesAdvanced
Press enter or click OK.
Click “Environment Variables…” in the resultant menu..
Click the Path system variable, then click Edit...
Click New in the “Edit environment variable” menu.
Enter the path to the folder in which you have placed Fioctl.

An example path string if installing to a folder on the desktop would look like this.

C:\Users\Gavin\Desktop\fio\bin

You should now be able to open cmd.exe or powershell.exe and type fioctl.

Authenticating Fioctl¶

With Fioctl installed, authenticate it with our backend. For this, you will generate OAuth2 application credentials for interacting with the FoundriesFactory API:

fioctl login
 Please visit:

 https://app.foundries.io/settings/credentials/

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

 Client ID:

Fioctl will now ask for your Client ID and Secret. Follow the next steps to generate them.

Adding Application Credentials¶

Go to Application Credentials and click on + New Credentials.

../../_images/application_credentials.png

Fig. 5 Application Credentials¶

Complete with a Description and the Expiration date and select next.

For Fioctl, check the Use for tools like fioctl box and select your Factory. You can revoke this access and set up a new credential later once you are familiar with the API Access.

Fig. 6 API Token¶

Tip

We recommend creating a new API token for each computer you plan to use our tools with. For example, if you intend to develop on both a laptop and a desktop, create a new token for each, as you would with SSH keys. This way you can revoke tokens for individual systems, should they be compromised.

Use the Client ID and Secret to finish the Fioctl login.

Fig. 7 Client ID and Secret¶

fioctl login
 Please visit:

 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.

Configuration¶

When working with multiple factories, specifying a factory name is mandatory. It can be set using 3 different methods:

Argument:

fioctl targets list --factory <factory>

Environment Variable:

export FIOCTL_FACTORY=<factory>
fioctl targets list

Configuration File:

echo "factory: <factory>" >> $HOME/.config/fioctl.yaml
fioctl targets list