Hey! These docs are for version 1.0, which is no longer officially supported. Click here for the latest version, 2.0!

Installing the Pennsieve Agent

Command Line Interface and background agent for interacting with the platform

❗️

Deprecated

This document describes an older version of the Pennsieve agent which is deprecated and will no longer be supported starting in Jan. 2023.

Overview

The Pennsieve Agent is an application that runs natively on Mac, Linux and Windows and is required for optimal performance of the MATLAB and Python clients. In addition, the Pennsieve Agent provides a Command Line Interface (CLI) for the Blackfynn platform.

The Github for the Pennsieve client can be found here: https://github.com/Pennsieve/agent and you can download the latest version of the Agent by either navigating to the latest release on Github or download the installer directly from this document.

Installing the Agent

Windows

Download and install Pennsieve-0.3.5-x86_64.msi

  • The Pennsieve home directory will be created in C:\Users\<user>\.pennsieve.
  • The agent executable will be installed to C:\Program Files\Pennsieve\pennsieve.exe.
  • The agent will automatically be added to your path.

macOS

Download and install pennsieve-0.3.5.pkg

  • The Pennsieve home directory will be created in /Users/<user>/.pennsieve.
  • The agent executable will be installed to `/usr/local/opt/pennsieve/bin/pennsieve``.
  • Add the Pennsieve agent to your path by running the following in your terminal:
echo 'export PATH="/usr/local/opt/pennsieve/bin:$PATH"' >> ~/.profile && source ~/.profile

Debian Linux

Download and install pennsieve_0.3.5_amd64.deb

  • The Pennsieve home directory will be created in /home/<user>/.pennsieve.
  • The agent executable will be installed to /opt/pennsieve/bin/pennsieve.
  • Add the Pennsieve agent to your path by running the following in your terminal:
export PATH="/opt/pennsieve/bin:$PATH"' >> ~/.profile && source ~/.profile

Running the Pennsieve Agent

To run the Pennsieve Agent, or use the CLI tools, open a terminal and run:

pennsieve version

For a full list of commands and CLI documentation, run:

pennsieve --help

Did this page help you?