search

brainlife / cli

brainlife.io Command Line Interface (CLI)
https://brainlife.io
MIT License
2 stars 5 forks source link

show required configuration parameters an app query #10

Closed soichih closed 6 years ago

soichih commented 6 years ago

Brad suggests we could display required config parameters when a user query for an App. I think we could display a "usage" for each App that user can use as a template for the real config object to pass for --config.

stevengeeky commented 6 years ago

PR #15 displays an app's config in the following format after bl app query:

Id: 5ab145a5029f78002be2c45a
Name: mrtrix3 act
Service: brain-life/app-mrtrix3-act
Type: (dwi: neuro/dwi, anat: neuro/anat/t1w) -> (tracking: neuro/track, tensor: neuro/tensor)
Description: perform Anatomically Constrained Tractography (ACT) on single or multi-shell data.
Config:
    imaxs: (type: string) (default: 2)
    curvs: (type: string) (default: 5 10 20 40 80)
    num_fibers: (type: string) (default: 25000)
    min_length: (type: string) (default: 10)
    max_length: (type: string) (default: 200)
    tensor_fit: (type: string) (default: ' ')
    ens_lmax: (type: boolean)
    norm: (type: boolean)
    do_prb2: (type: boolean)
    do_prb1: (type: boolean)
    do_detr: (type: boolean)
    do_dtdt: (type: boolean)
    do_dtpb: (type: boolean)
soichih commented 6 years ago

@bacaron Does this look ok?

bacaron commented 6 years ago

Yeah that looks okay to me!

On Jun 8, 2018, at 9:23 AM, Soichi Hayashi notifications@github.com wrote:

@bacaron https://github.com/bacaron Does this look ok?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/brain-life/cli/issues/10#issuecomment-395759357, or mute the thread https://github.com/notifications/unsubscribe-auth/AVFQmQTLId5A15AIs_ORzTDCTp7Jyq6kks5t6nrjgaJpZM4UXzlZ.