Versions Compared

Old Version 7

changes.mady.by.user Joe Ylagan

Saved on

compared with

New Version 8

changes.mady.by.user Ben Baker

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The cyrus command line application can be downloaded by logging into https://api-authorization.cyrusbio.com and clicking the “Get Files” button. Below are specific instructions for installing the application in Windows, MacOS, and Linux

Windows

  1. Download the Windows engine-client executable from https://api-authorization.cyrusbio.com

  2. Rename the file to cyrus.exe and move cyrus.exe into %USERPROFILE%\AppData\Local\Microsoft\WindowsApps

  3. Open PowerShell by opening the Windows menu and typing “PowerShell”

  4. Run cyrus help

  5. If the application is correctly installed you should see a usage message like this:

    A screenshot of the output of the cyrus help command. it shows basic usage instructions for the applicationImage Modified

Mac OS

Note

 In an upcoming release Cyrus will distribute the Command Line Application as a signed binary, which will make this installation progress significantly simpler by eliminating steps 4-6.  For now, follow these steps

  1. Download the MacOS binary from https://api-authorization.cyrusbio.com/

  2. Copy the binary with the following command: cp <binary-name> /usr/local/bin/cyrus

  3. Make the file executable with chmod +x /usr/local/bin/cyrus

  4. Run cyrus, you will see a window like the one below.  click “Cancel”:

    A screenshot of an error message in OS X. it says 'cyrus cannot be opened because the developer cannot be verified' and has two buttons labelled 'Move to Trash' and 'Cancel'Image Modified

  5. Open “System Preferences”, Click “Security and Privacy” and then the “General” tab, you should see a window like the one below.  Click “Allow Anyway”:

    The Mac OS 'Security and Privacy' preferences pane. At the bottom is the 'Allow apps downloaded from' section which says 'cyrus was blocked from use because it is not from an identified developer'. the 'allow anyway' button is at the bottom right of the windowImage Modified

  6. Run cyrus again, you will see another window like the one below. Click “Open”

    An error message which says 'macOS cannot verify the devleoper of 'cyrus'. Are you sure you want to open it'. with the buttons 'Move to trash' 'Open' and 'Cancel'Image Modified

Linux

  1. Download the Linux binary from https://api-authorization.cyrusbio.com/

  2. Copy the binary with the following command: cp <binary-name> /usr/local/bin/cyrus

  3. Make the file executable with chmod +x /usr/local/bin/cyrus

Upgrading

Once the command line application has been initially installed, it can be upgraded to the latest version by running the command cyrus upgrade. If an upgrade is available, you will be prompted to install it.

...

You will be asked to entire your API client ID, secret key, server, and port.  For server, you should enter the domain name you were given during onboarding and for the port you should enter “443”. You can get your client ID and secret from api-authorization.cyrusbio.com.

Submitting Jobs

A job can be submitted with a command like this:

...