The Perl SDK provides a generic set of wrappers so you can make API calls easily.

It should be treated as alpha/experimental. Currently, limitations include:

  • Verbose syntax.
  • No native Keep client.
  • No CPAN package.


Option 1: Install from distribution packages

First, add the appropriate package repository for your distribution.

On Debian-based systems:

~$ sudo apt-get install libjson-perl libio-socket-ssl-perl libwww-perl libipc-system-simple-perl libarvados-perl

On Red Hat-based systems:

~$ sudo yum install perl-ExtUtils-MakeMaker perl-JSON perl-IO-Socket-SSL perl-Crypt-SSLeay perl-WWW-Curl libarvados-perl

Option 2: Install from source

First, install dependencies from your distribution. Refer to the package lists above, but don’t install libarvados-perl.

Then run the following:

~$ git clone
~$ cd arvados/sdk/perl
~$ perl Makefile.PL
~$ sudo make install

Test installation

If the SDK is installed, perl -MArvados -e '' should produce no errors.

If your ARVADOS_API_HOST and ARVADOS_API_TOKEN environment variables are set up correctly (see api-tokens for details), the following test script should work:

~$ perl <<'EOF'
use Arvados;
my $arv = Arvados->new('apiVersion' => 'v1');
my $me = $arv->{'users'}->{'current'}->execute;
print ("arvados.v1.users.current.full_name = '", $me->{'full_name'}, "'\n");
arvados.v1.users.current.full_name = 'Your Name'

Previous: R Reference Next: Examples

The content of this documentation is licensed under the Creative Commons Attribution-Share Alike 3.0 United States licence.
Code samples in this documentation are licensed under the Apache License, Version 2.0.