README.md

arc-export

Automatic building of a Docker container for exporting ARCs to Arc.json

Develop

use VS or VSCode tooling or run dotnet build or dotnet test from the command line.

Setup

local docker build

docker build . -t arc-export

docker run -v C:\Repos\ArcRepo:/arc arc-export:latest /arc-export -p arc

download container first

docker pull ghcr.io/nfdi4plants/arc-export:main

docker run -v C:\Repos\ArcRepo:/arc ghcr.io/nfdi4plants/arc-export:main /arc-export -p arc

Basic usage

Output format Selection

Output format can be specified with the -f flag, followed by one of the following:

• isa-json will produce a arc-isa.json file
• rocrate-metadata will produce a arc-ro-crate-metadata.json file
• summary-markdown will produce a arc-summary.md file

E.g.

docker run -v C:\Repos\ArcRepo:/arc arc-export:latest /arc-export -p arc -f rocrate-metadata -f isa-json -f summary-markdown

will produce all three output files.

Help

USAGE: arc-export [--help] --arc-directory <path> [--out-directory <path>]
                  [--output-format <isa-json|rocrate-metadata|summary-markdown>]

OPTIONS:

    --arc-directory, -p <path>
                          Specify a directory that contains the arc to convert.
    --out-directory, -o <path>
                          Optional. Specify a output directory for the invenio metadata record.
    --output-format, -f <isa-json|rocrate-metadata|summary-markdown>
                          Optional. Specify the output format. Default is ISA-JSON.
    --help                display this list of options.