Bamboost
bamboostclialias

bamboost.cli.alias

Source: https://gitlab.com/cmbm-ethz/bamboost/-/blob/main/bamboost/cli/alias.py

Attributes

  • subapp_alias=typer.Typer(name='alias', help='Manage collection aliases in the index.', no_args_is_help=True)

Functions

add(uid=typer.Argument(..., autocompletion=(_completion._get_uids_from_db), help='The unique ID of the collection to add an alias for.'), alias=typer.Argument(..., help='The alias to add to the collection.')) -> None

Add an alias to a collection in the index by its unique ID.

Arguments:
  • uid:str=typer.Argument(..., autocompletion=(_completion._get_uids_from_db), help='The unique ID of the collection to add an alias for.')
  • alias:str=typer.Argument(..., help='The alias to add to the collection.')
remove(uid=typer.Argument(..., autocompletion=(_completion._get_uids_from_db), help='The unique ID of the collection to remove an alias from.'), alias=typer.Argument(..., help='The alias to remove from the collection.', autocompletion=(_completion._get_aliases_of_collection))) -> None

Remove an alias from a collection in the index by its unique ID.

Arguments:
  • uid:str=typer.Argument(..., autocompletion=(_completion._get_uids_from_db), help='The unique ID of the collection to remove an alias from.')
  • alias:str=typer.Argument(..., help='The alias to remove from the collection.', autocompletion=(_completion._get_aliases_of_collection))
get(alias) -> None

Get the unique ID of a collection by its alias.

Arguments:
  • alias:typing.Annotated[str, typer.typer.Argument(..., help='The alias to look up.')]

_render

Previous Page

app

Next Page

On this page

Attributes
Functions
add
remove
get