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.
Install Released Binaries
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
collection Create and manage collections
completion Generate the autocompletion script for the specified shell
context Manage and set access to various IVCAP deployments
datafabric Query the datafabric and create and manage aspects within
help Help about any command
job Create and manage jobs
mcp Start an MCP server for all tools on an IVCAP platform
order Create and manage orders
package Push/pull and manage service packages
queue Create and manage queues
secret Set and list secrets
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 sd-dev for the IVCAP deployment at https://develop.ivcap.net. Please check first the details of deployment you want to use.
% ivcap context create sd-dev https://develop.ivcap.net
Context 'sd-dev' created.
If we have multiple contexts, we can easily switch with context set
% ivcap context set sd-dev
Switched to context 'sd-dev'.
The following command lists all the configured contexts:
% ivcap context list
+---------+-----------+-----------------------------+--------------------------------+
| CURRENT | NAME | ACCOUNTID | URL |
+---------+-----------+-----------------------------+--------------------------------+
| * | sd-dev | urn:ivcap:account:4c65b865 | <http://develop.ivcap.net> |
+---------+-----------+-----------------------------+--------------------------------+
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.
Service
To list all available services:
% ivcap services list --limit 2
+----+--------------------------+------------------------------------------------------------------+
| ID | NAME | DESCRIPTION |
+----+--------------------------+------------------------------------------------------------------+
| @1 | llama-index-agent-runner | Executes queries or chats with LlamaIndex agents. |
+----+--------------------------+------------------------------------------------------------------+
| @2 | gene-whisperer | A tool for answering genomic questions. Collates information |
| | | across various sources such as NCBI, UniProt, Blast and |
| | | GeneOntology to answer biomedical questions. |
+----+--------------------------+------------------------------------------------------------------+
To get more details about a specific service
% ivcap service get @1
Name llama-index-agent-runner
Description Executes queries or chats with LlamaIndex agents.
ID urn:ivcap:service:b35153c3-3f66-5ed1-9e33-c46949783575 (@1)
Status active
Controller urn:ivcap:schema.service.rest.1
Policy urn:ivcap:policy:ivcap.open.metadata
Account urn:ivcap:account:45a06508-5c3a-4678-8e6d-e6399bf27538
Parameters None
Follow this link for more details about the service command.
Jobs
A job is a specific instantiation of a service.
% ivcap job
Create and manage jobs
Usage:
ivcap job [command]
Aliases:
job, js, jobs
Available Commands:
create Create a new job
get Fetch details about a single job
list List existing jobs
Flags:
-h, --help help for job
To list all jobs initiated or visible to the user:
% ivcap job list --limit 2
At Time 2 seconds ago (13 Oct 25 11:29 AEDT)
Jobs ┌────┬────────────────────────────────┬───────────┬──────────────┐
│ ID │ SERVICE │ STATUS │ REQUESTED AT │
├────┼────────────────────────────────┼───────────┼──────────────┤
│ @1 │ Batch service example │ succeeded │ 2 days ago │
│ @2 │ Gene Ontology (GO) Term Mapper │ succeeded │ 4 days ago │
└────┴────────────────────────────────┴───────────┴──────────────┘
... @3
To obtain the details of an existing job:
% ./ivcap job get @1
Name b-3678e5f1-8fb7-5ad6-b65b-8bd8c23c0948-szje7stt
ID urn:ivcap:job:763e4b1d-26e4-4cd2-ba51-fb5a912a1e9c (@1)
Status succeeded
Started At 2 days ago (10 Oct 25 13:29 AEDT)
Finished At 2 days ago (10 Oct 25 13:29 AEDT)
Service urn:ivcap:service:3678e5f1-8fb7-5ad6-b65b-8bd8c23c0948 (@2)
Policy urn:ivcap:policy:ivcap.base.service
Account urn:ivcap:account:45a06508-....
Result-Type application/vnd.ivcap.urn:sd:schema:batch-tester.1
Result {
"$schema": "urn:sd:schema:batch-tester.1",
"msg": "CPU consumption finished.",
"run_time": 2.0046427249908447
}
To crate a job from a service:
% ivcap job create -h
Create a new job by executing the service 'service-id' with the
input paramters defined in either a provided (json) file or a reference
to an aspect containing the parameter definitions. If the job definition is
provided through 'stdin' use '-' as the file name and also include the --format flag
Usage:
ivcap job create [flags] service-id -f job-input|- -a aspect-urn --watch --stream
Flags:
-a, --aspect string URN of aspect containing job parameters
-f, --file string Path to job description file
--format string Format of input file [json, yaml] (default "json")
-h, --help help for create
--stream if set, print job related events to stdout
--watch if set, watch the job until it is finished
The --watch flag will block the command until the job has finished and then return the result.
% ivcap job create urn:ivcap:service:3678e5f1-8fb7-5ad6-b65b-8bd8c23c0948 -f .../load_1.json --watch
Name b-3678e5f1-8fb7-5ad6-b65b-8bd8c23c0948-oimafhg3
ID urn:ivcap:job:939f55f5-243b-49ef-8176-ee32eef966de (@1)
Status succeeded
Started At 12 seconds ago (13 Oct 25 13:35 AEDT)
Finished At 1 second ago (13 Oct 25 13:36 AEDT)
Service urn:ivcap:service:3678e5f1-8fb7-5ad6-b65b-8bd8c23c0948 (@2)
Policy urn:ivcap:policy:ivcap.base.service
Account urn:ivcap:account:45a06508-5c3a-4678-8e6d-e6399bf27538
Result-Type application/vnd.ivcap.urn:sd:schema:batch-tester.1
Result {
"$schema": "urn:sd:schema:batch-tester.1",
"msg": "CPU consumption finished.",
"run_time": 10.001116037368774
}
In contrast, the --stream flag will also print out any events generated by the job during its execution. The individual events will
be a mix of system related events (e.g. ivcap.job.status) and systemd specific ones (e.g. urn:ag-ui:schema:event.1).
% ivcap job create urn:ivcap:service:3678e5f1-8fb7-5ad6-b65b-8bd8c23c0948 -f .../load_1.json --stream
---------
{
"SeqID": "00007016",
"EventID": "0199db6f-766e-7ebf-b113-96664880bcdb",
"Type": "ivcap.job.status",
"Schema": "urn:ivcap:schema:job.status.1",
"Source": "b-3678e5f1-8fb7-5ad6-b65b-8bd8c23c0948-gyfgm6rl",
"Timestamp": "2025-10-13T02:38:59.141759565Z",
"Data": {
"job-urn": "urn:ivcap:job:a63971a8-4e99-460c-8e5e-d2b00a50e3f2",
"status": "executing"
}
}
---------
{
"SeqID": "00007017",
"EventID": "0199db6f-7721-7f05-8230-6c835856dc6d",
"Type": "ivcap.job.event",
"Schema": "urn:ag-ui:schema:event.1",
"Source": "b-3678e5f1-8fb7-5ad6-b65b-8bd8c23c0948-gyfgm6rl",
"Timestamp": "2025-10-13T02:38:59.354310095Z",
"Data": {
"$schema": "urn:ag-ui:schema:event.1",
"raw_event": "Consuming CPU for 10 seconds at 80%",
"step_name": "consume_compute",
"timestamp": 1760323139188,
"type": "STEP_STARTED"
}
}
---------
...
---------
Name b-3678e5f1-8fb7-5ad6-b65b-8bd8c23c0948-gyfgm6rl
ID urn:ivcap:job:a63971a8-4e99-460c-8e5e-d2b00a50e3f2 (@1)
Status succeeded
Started At 11 seconds ago (13 Oct 25 13:38 AEDT)
Finished At 1 second ago (13 Oct 25 13:39 AEDT)
Service urn:ivcap:service:3678e5f1-8fb7-5ad6-b65b-8bd8c23c0948 (@2)
Policy urn:ivcap:policy:ivcap.base.service
Account urn:ivcap:account:45a06508-5c3a-4678-8e6d-e6399bf27538
Result-Type application/vnd.ivcap.urn:sd:schema:batch-tester.1
Result {
"$schema": "urn:sd:schema:batch-tester.1",
"msg": "CPU consumption finished.",
"run_time": 10.020376205444336
}
Artifacts
% ./ivcap artifact
Create and manage artifacts
Usage:
ivcap artifact [command]
Aliases:
artifact, a, artifacts
Available Commands:
create Create a new artifact
download Download the content associated with this artifact
get Fetch details about a single artifact
list List existing artifacts
upload Resume uploading artifact content
Flags:
-h, --help help for artifact
To check the details of the artifact created by the previously placed order:
% ivcap artifact get urn:ivcap:artifact:017ecae8...
ID urn:ivcap:artifact:017ecae8...
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... -f /tmp/out.png
Successfully wrote 50855 bytes to /tmp/out.png
Follow this link for more details about the artifact command.
Packages
The computation behind each service is encapsulated by one or more "packages" (aka Docker containers). This command supports managing them.
Upload packages (aka Docker containers)
ivcap package push -f alpine:3.20.1
Pushing alpine:3.20.1 from local, may take multiple minutes depending on the size of the image ...
40df18f632 4.21MB already exits
092561eea8 1.45KB uploaded
registry.kube-system.svc.cluster.local/0f0e3f57-80f7-4899-9b69-459af2efd789/alpine:3.20.1 pushed
Note: If the image is larger than 2GB we need to push it from a local registry instead of pusing it directly.
- Start a local registry
docker run -d -p 8080:5000 --name registry-2 registry:2
- Tag image
docker tag alpine:3.20.1 localhost:8080/alpine:3.20.1
- Push to local registry
docker push localhost:8080/alpine:3.20.1
- Then push from local registry to ivcap service
ivcap package push -f localhost:8080/alpine:3.20.1
Pushing localhost:8080/alpine:3.20.1 from localhost:8080, may take multiple minutes depending on the size of the image ...
a258b2a6b5 3.90MB uploaded
092561eea8 1.45KB uploaded
registry.kube-system.svc.cluster.local/0f0e3f57-80f7-4899-9b69-459af2efd789/alpine:3.20.1 pushed
List packages
ivcap package ls
registry.kube-system.svc.cluster.local/0f0e3f57-80f7-4899-9b69-459af2efd789/alpine:3.20.1
registry.kube-system.svc.cluster.local/0f0e3f57-80f7-4899-9b69-459af2efd789/cv_pipeline_v0_pm1:2024-03-27_16-48-57
registry.kube-system.svc.cluster.local/0f0e3f57-80f7-4899-9b69-459af2efd789/python:3.13.0
Follow this link for more details about the package command.
Build from Source
Prerequisites
You will need the following installed:
- go version >= 1.22.5 (e.g.
snap install go --classic) - golangci-lint (e.g.
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.57.2) - gocritic (e.g.
go install -v github.com/go-critic/go-critic/cmd/gocritic@latest; you may also need to add~/go/binto yourPATH) - staticcheck (e.g.
go install honnef.co/go/tools/cmd/staticcheck@latest) - gosec (e.g.
go install github.com/securego/gosec/v2/cmd/gosec@latest) - govulncheck (e.g.
go install golang.org/x/vuln/cmd/govulncheck@latest) - addlicense (e.g.
go install github.com/nokia/addlicense@latest)
Install prerequisites
The prerequisite tools can be installed by running the make target:
make install-tools
Deprecated: 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.
Build & Install
To build and install from local source code, ensure you have the prerequisites and run:
make build
make install
If your Go paths are configured correctly, you should now have the ivcap
command available in your shell.
To build and install without performing any code checks (implicitly done via make check) run:
make build-dangerously
make install-dangerously
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
adapter
Program to create, update & delete aspect schemas in cayp Adapted from https://github.com/maxott/cayp-cli/blob/main/pkg/adapter/adapter.go
|
Program to create, update & delete aspect schemas in cayp Adapted from https://github.com/maxott/cayp-cli/blob/main/pkg/adapter/adapter.go |
Click to show internal directories.
Click to hide internal directories.