Skip to content
This repository has been archived by the owner on Jun 19, 2023. It is now read-only.

Latest commit

 

History

History
49 lines (29 loc) · 961 Bytes

cli.md

File metadata and controls

49 lines (29 loc) · 961 Bytes

cli

Contents

bg_cli [#7]

Check the source code online

def bg_cli(command, atlas_name=None, force=False, show=False,
    key=None, value=None):

 
docstring:

Command line dispatcher. Given a command line call to `brainglobe`

it calls the correct function, depending on which `command` was
    passed.

Arguments:

----------

command: str. Name of the command:

- list: list available atlases

- install: isntall new atlas

- update: update an installed atlas

- config: modify config

show: bool. If True when using `list` shows the local path of
    installed atlases

and when using 'config' it prints the modify config results.

atlas_name: ts. Used with `update` and `install`, name of the atlas to
    install

force: bool, used with `update`. If True it forces the update