ivcap-cli

README

IVCAP - A Command-line Tool to interact with an IVCAP deployment

IVCAP is helping researchers better investigate their domains and derive new insights by collecting, processing and analysing multi-modal and multi-scale data and better facilitating data provenance and thereby fostering interdisciplinary collaboration.

IVCAP has an extensive REST API which is usually called directly from applications or scientific notebooks. However, to support simple data operation from the command line, we developed this simple command-line tool. It only covers the subset of the IVCAP API, but we would be very excited to receive pull requests to extend it's functionality or fix bugs.

Developing

Prerequisites

You will need the following installed:

• go version >= 1.22.2 (e.g. snap install go --classic)
• golangci-lint (e.g. snap install golangci-lint)
• gocritic (e.g. go install -v github.com/go-critic/go-critic/cmd/gocritic@latest; you may also need to add ~/go/bin to your PATH)
• staticcheck (go install honnef.co/go/tools/cmd/staticcheck@latest)
• gosec (go install github.com/securego/gosec/v2/cmd/gosec@latest)
• govulncheck (go install golang.org/x/vuln/cmd/govulncheck@latest)
• addlicense (go install github.com/nokia/addlicense@latest)

Build

To build, ensure you have the prerequisites and then run make.

Install

To install from the local development code, run make install. You should now have the ivcap-cli command available in your shell.

Install

There are ready to use binaries for some architectures available at the repo's release tab.

If you use homebrew, you can install it by:

brew tap brew tap ivcap-works/ivcap
brew install ivcap

Usage

% ivcap
A command line tool to to more conveniently interact with the
API exposed by a specific IVCAP deployment.

Usage:
  ivcap [command]

Available Commands:
  artifact    Create and manage artifacts
  aspect      Create and manage aspects
  collection  Create and manage collections
  completion  Generate the autocompletion script for the specified shell
  context     Manage and set access to various IVCAP deployments
  help        Help about any command
  order       Create and manage orders
  service     Create and manage services

Flags:
      --access-token string   Access token to use for authentication with API server [IVCAP_ACCESS_TOKEN]
      --context string        Context (deployment) to use
      --debug                 Set logging level to DEBUG
  -h, --help                  help for ivcap
      --no-history            Do not store history
  -o, --output string         Set format for displaying output [json, yaml]
      --silent                Do not show any progress information
      --timeout int           Max. number of seconds to wait for completion (default 30)
  -v, --version               version for ivcap

Use "ivcap [command] --help" for more information about a command.

Configure context for a specific deployment

With the following command we are creating a context named cip-2 for the IVCAP deployment at https://api2.green-cirrus.com

% ivcap context create cip-2 https://api2.green-cirrus.com
Context 'cip-2' created.

If we have multiple contexts, we can easily switch with context set

% ivcap context set cip-2
Switched to context 'cip-2'.

The following command lists all the configured contexts:

% ivcap context list
+---------+-----------+-----------------------------+--------------------------------+
| CURRENT | NAME      | ACCOUNTID                   | URL                            |
+---------+-----------+-----------------------------+--------------------------------+
| *       | cip-2     | urn:ivcap:account:4c65b865  | <http://api2.green-cirrus.com> |
+---------+-----------+-----------------------------+--------------------------------+

To obtain an authorisation token, some deployments provide a username/password based identity provider.

% ivcap context login


    █▀▀▀▀▀█    ▀█  ▄▀▄▀▀ ▄▄▀▄ █▀▀▀▀▀█
    █ ███ █ █  █▀ ▀█▀ █  ▀▀█  █ ███ █
    █ ▀▀▀ █ █ ▀▀▄▀▀▀▀█▀ ▀█ ▀▀ █ ▀▀▀ █
    ▀▀▀▀▀▀▀ █▄█ █ █ █ █ █▄█ ▀ ▀▀▀▀▀▀▀
    █ ██▀▀▀▄▄▄ ▄ ██ ██▄█▀▄█▄█ ██▀██ ▄
    █▀▄▄ ▀▀  █ █▀█▀▀▀█▄  █  █ ▄ █▄█▀
...
To login to the IVCAP Service, please go to:  https://id-provider.com/activate?user_code=....
or scan the QR Code to be taken to the login page
Waiting for authorisation...

Follow this link for more details about the context command.

Services

To list all available services:

% ivcap services list --limit 2
+--------+------------------------+-------------------------------+
| ID     | NAME                   | ACCOUNT                       |
+--------+------------------------+-------------------------------+
| @1     | image-analysis-example | urn:ivcap:account:45a06508... |
| @2     | cv-pipeline-v0-ps1-gpu | urn:ivcap:account:29df453d... |
| ... @3 |                        |                               |
+--------+------------------------+-------------------------------+

To get more details about a specific service

% ivcap service get @1

          ID  urn:ivcap:service:19f9c31e...
        Name  image-analysis-example
 Description  A simple IVCAP service creating a thumbnail and reporting stats on a collection of images
      Status
  Account ID  urn:ivcap:account:45a06508...
  Parameters  ┌────────┬────────────────────────────────┬────────────┬─────────┬──────────┐
              │ NAME   │ DESCRIPTION                    │ TYPE       │ DEFAULT │ OPTIONAL │
              ├────────┼────────────────────────────────┼────────────┼─────────┼──────────┤
              │ images │ Collection of image artifacts. │ collection │         │ true     │
              ├────────┼────────────────────────────────┼────────────┼─────────┼──────────┤
              │  width │ Thumbnail width.               │ int        │ 100     │ false    │
              ├────────┼────────────────────────────────┼────────────┼─────────┼──────────┤
              │ height │ Thumbnail height.              │ int        │ 100     │ false    │
              └────────┴────────────────────────────────┴────────────┴─────────┴──────────┘

Follow this link for more details about the service command.

Orders

To place an order:

% ivcap orders create \
     urn:ivcap:service:d939b74d... \
     --name "Order for max" \
     msg="Hi, how are you"
Order 'urn:ivcap:order:81b204e8...' with status 'Pending' submitted.

To check on the status of an order:

% ivcap orders get urn:ivcap:order:81b204e8...

         ID  urn:ivcap:order:f169f54d-ec8d-4d6a-af17-0c1c33625379
       Name  urn:ibenthos:collection:indo_flores_0922:LB4 UQ PhotoTransect@256028
     Status  succeeded
    Ordered  6 months ago (01 Oct 23 17:26 AEDT)
    Service  image-analysis-example (@15)
 Account ID  urn:ivcap:account:45a06508-5c3a-4678-8e6d-e6399bf27538
 Parameters  ┌─────────────────────────────────────────────────┐
             │ images =  @1 (urn:ivcap:collection:508a2aba...) │
             │  width =  100                                   │
             │ height =  100                                   │
             └─────────────────────────────────────────────────┘
   Products  ┌────┬───────────────┬──────────────────┐
             │ @2 │ result.png    │ image/png        │
             │ @3 │ stats.json    │ application/json │
             │ @4 │ thumbnail.png │ image/png        │
             └────┴───────────────┴──────────────────┘
   Metadata  ┌─────┬────────────────────────────────────────┐
             │ @6  │ urn:ivcap:schema:order-uses-workflow.  │
             │ @7  │ urn:ivcap:schema:order-uses-artifact.1 │
             │ ...                                          │
             └─────┴────────────────────────────────────────┘

Follow this link for more details about the order command.

Artifacts

To check the details of the artifact created by the previously placed order:

% ivcap artifact get urn:ivcap:artifact:017ecae8-3d39-4297-a94f-00ddf9b26611

         ID  urn:ivcap:artifact:017ecae8-3d39-4297-a94f-00ddf9b26611
       Name  out.png
     Status  available
       Size  50855
  Mime-type  image/png
 Account ID  urn:ivcap:account:58d8e161...
   Metadata  ┌────┬─────────────────────────────────────────────┐
             │ @1 │ urn:ivcap:schema:artifact.1                 │
             │ @2 │ urn:ivcap:schema:artifact-usedBy-order.1    │
             │ @3 │ urn:example:schema:image-analysis:thumbnail │
             └────┴─────────────────────────────────────────────┘

To download the content associated with the artifact.

% ivcap artifact download urn:ivcap:artifact:017ecae8-3d39-4297-a94f-00ddf9b26611 -f /tmp/out.png
Successfully wrote 50855 bytes to /tmp/out.png

Follow this link for more details about the artifact command.