Getting started with the Blackfynn Agent

Configuring the Blackfynn Agent

The first step is to configure the agent to use your Blackfynn account by registering an API key/secret. Use the Blackfynn web application to generate API credentials

The agent configuration is built based on a config file stored in ~/.blackfynn/config.ini.

Navigate to the folder where the Blackfynn Agent is installed. Look here for the default locations for each operating system. Now, use the config wizard command to create a new config file. Provide a name for your new profile and the API key and secret that you created in the web application.

$ blackfynn_agent config wizard

New profiles can be added to your configuration file using the profile create command.

$ blackfynn_agent profile create
Create a new profile:
  Profile name: [default]  myProfile
  API token: xxxx
  API secret: xxxx

Verify that the newly created profile is selected using:

$ blackfynn_agent profile
Current profile: <new Profile>

If the newly selected profile is not selected as the active profile, use the profile switch command to switch the active profile to the newly created profile. To verify you can access your account, use the whoami command to request some information about your Blackfynn account.

$ blackfynn_agent whoami
+-----------------+-----------------------------------------------------+
| NAME            | user@email.com                                      |
| USER ID         | N:user:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx         |
| ORGANIZATION    | User Oganization                                    |
| ORGANIZATION ID | N:organization:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
+-----------------+-----------------------------------------------------+

Using environment variable overrides

Blackfynn credentials can also be configured using the following environment variables.

BLACKFYNN_API_TOKEN
BLACKFYNN_API_SECRET

As long as both of these environment variables are set, the agent will use these credentials instead of any profiles found in the config.ini file.

Getting help

You can find documentation for the agent using the --help option. For example:

$ blackfynn_agent --help

or

$ blackfynn_agent upload-status --help