Commit 101f745d authored by Maxime Hubert's avatar Maxime Hubert
Browse files

Refresh documentation

parent 43ca261d
Pipeline #139816 passed with stage
in 31 seconds
......@@ -19,7 +19,7 @@ Get the CLI
Clone the repository:
```
git clone https://gitlab.kitware.com/alexandreB/diva_evaluation_cli.git
git clone https://gitlab.kitware.com/actev/diva_evaluation_cli.git
```
Install it
......@@ -76,7 +76,7 @@ Fork it
Click on the “Fork” button to make a copy of the repository in your own space and add this repository as a remote upstream to get the latest updates
```
$ git remote add upstream https://gitlab.kitware.com/alexandreB/diva_evaluation_cli.git
$ git remote add upstream https://gitlab.kitware.com/actev/diva_evaluation_cli.git
```
Update it
......@@ -102,5 +102,4 @@ More information about the development and the update of the CLI here: [developm
Contact
=======
* alexandre.boyer@nist.gov
* maxime.hubert@nist.gov
* diva-nist@nist.gov
......@@ -62,45 +62,11 @@ actev get-system git -u <git repository url> ... -l <location> -n <directory nam
Example:
```
actev get-system git -u https://gitlab.kitware.com/alexandreB/diva_evaluation_cli.git -l /tmp
actev get-system git -u https://gitlab.kitware.com/actev/diva_evaluation_cli.git -l /tmp
```
## get-system docker
### Description
Downloads a docker image
### Parameters
| Name | Id | Required | Definition |
|-----------|-----|----------------|----------------------------|
| url | u | True | url to get the system |
| user | U | False | username to access the url |
| password | p | False | password to access the url |
### Usage
Generic command:
```
actev get-system docker -u <docker image url>
```
With username and password:
```
actev get-system docker -u <docker image url> -U <username> -p <password>
```
:warning: if your password starts with *-* as in this example: `-9r45ijFo0`, you should write `--password=-9r45ijFo0` instead of `-p -9r45ijFo0`. Otherwise, the value will be interpreted as an argument to parse.
Example:
```
actev get-system docker -u gitlab.kitware.com:4567/diva-baseline/diva-baseline:eval_cli
```
## get-system archive
## get-system other
### Description
Downloads a web resources as a zip/tar file
......@@ -120,25 +86,25 @@ Downloads a web resources as a zip/tar file
Generic command:
```
actev get-system other -u <web resource url>
actev get-system archive -u <web resource url>
```
With username and password:
```
actev get-system other -u <web resource url> -U <username> -p <password>
actev get-system archive -u <web resource url> -U <username> -p <password>
```
With a token:
```
actev get-system git -u <web resource url> -t <token>
actev get-system archive -u <web resource url> -t <token>
```
Store the system in a specific directory:
```
actev get-system git -u <web resource url> ... -l <location>
actev get-system archive -u <web resource url> ... -l <location>
```
:information_source: You can also directly add your credentials inside the url.
......@@ -149,5 +115,5 @@ actev get-system git -u <web resource url> ... -l <location>
Example:
```
actev get-system other -u https://path/to/file.tgz -l /tmp
actev get-system archive -u https://path/to/file.tgz -l /tmp
```
......@@ -6,7 +6,7 @@ Overview
The ActEV Independent Evaluation Command Line Interface (ActEV EvalCLI) defines an abstract interface for command line interaction model that is consistent for all developers while allowing freedom of underlying implementation. Consult [introduction](introduction.md) for a more detailed description of the CLI and how it will be used.
The abstract CLI is contained in the GIT Repo [diva_evaluation_cli](https://gitlab.kitware.com/alexandreB/diva_evaluation_cli). This contains a stubbed-out implementation of the CLI. The Baseline Active Detection System (RC3D) has been adapted to the CLI as an example implementation. It is available in the GIT repo [here](https://gitlab.kitware.com/alexandreB/diva_evaluation_cli/tree/baseline_system_master).
The abstract CLI is contained in the GIT Repo [diva_evaluation_cli](https://gitlab.kitware.com/actev/diva_evaluation_cli). This contains a stubbed-out implementation of the CLI. The Baseline Active Detection System (RC3D) has been adapted to the CLI as an example implementation. It is available in the GIT repo [here](https://gitlab.kitware.com/actev/diva_evaluation_cli/tree/baseline_system_master).
The preferred workflow for the participant to implement the CLI is to GIT ‘fork’ the main branch of the abstract CLI and then implement the Entry Points. This can be accomplished two ways: branching within the NIST GIT Repo or using a linked branch from your team’s Repo. Contact NIST if you have questions.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment