Fioctl CLI Installation¶
Fioctl, is used to manage:
Install From Source¶
This requires that you have Golang installed. See https://golang.org/doc/install for instructions.
If you intend to use Fioctl on a non X86_64 platform (like a Raspberry
Pi/Pinebook/Smartphone) such as ARM, RISC-V, PPC, etc. Fioctl can be compiled
and installed from the latest sources and installed via Golang’s own package
go get github.com/foundriesio/fioctl
Now that Fioctl is installed, you must authenticate with our backend before you’re able to use it. This requires you to generate OAuth2 application credentials for interacting with Factory APIs:
Fioctl will now ask for your application credentials and walk you through the authentication process.
Go to Token and create a new Api Token by clicking on the + New Token. 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. Remember that you can revoke this access and set up a new credential later once you are familiar with the API Access.
We recommend creating a new API token for each device you plan to use our tools with. For example, if you intend to develop on multiple systems such as a laptop and a desktop, you should create a new token for each, just as you would with SSH keys. This way you can revoke tokens for individual systems, should they be compromised.
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
Refer to the Fioctl section of the documentation to learn more about configuration.