Attributes

Functions

new(path, *, alias=None, description=None, tags=None) -> None

Create a new collection.

path:typing_extensions.Annotated[str, typer.typer.Argument(..., help='Path of the collection to create.')]
alias:typing_extensions.Annotated[typing.Optional[str], typer.typer.Option(--, -a, help='Alias for the collection.')]=None
description:typing_extensions.Annotated[typing.Optional[str], typer.typer.Option(--description, -d, help='Description for the collection.')]=None
tags:typing_extensions.Annotated[typing.Optional[str], typer.typer.Option(--tags, -t, help='Comma-separated tags for the collection.')]=None

yank(uid) -> None

Copy the UID of a collection to the clipboard. Only useful with completion.

uid:typing_extensions.Annotated[str, typer.typer.Argument(..., help='UID of the collection to yank.', autocompletion=(bamboost.cli._completion._get_uids_from_db))]

migrate() -> None

Create the new database file from a previous database schema. Useful if you have upgraded from 0.10.x to 0.11.x.

Command line interface for bamboost.

You can use this to list collections or simulations, create collections/simulations, and run simulations.