prefect.cli.block

Block command — native cyclopts implementation.

Manage blocks and block types.

Functions

register ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/block.py#L163" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

register()

Register blocks types within a module or file.

This makes the blocks available for configuration via the UI. If a block type has already been registered, its registration will be updated to match the block's current definition.

block_ls ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/block.py#L263" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

block_ls()

View all configured blocks.

block_delete ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/block.py#L309" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

block_delete(slug: Annotated[Optional[str], cyclopts.Parameter(help="A block slug. Formatted as '<BLOCK_TYPE_SLUG>/<BLOCK_NAME>'")] = None)

Delete a configured block.

block_create ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/block.py#L366" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

block_create(block_type_slug: Annotated[str, cyclopts.Parameter(help='A block type slug. View available types with: prefect block type ls', show_default=False)])

Generate a link to the Prefect UI to create a block.

block_inspect ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/block.py#L408" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

block_inspect(slug: Annotated[Optional[str], cyclopts.Parameter(help='A Block slug: <BLOCK_TYPE_SLUG>/<BLOCK_NAME>')] = None)

Displays details about a configured block.

list_types ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/block.py#L472" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

list_types()

List all block types.

blocktype_inspect ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/block.py#L526" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

blocktype_inspect(slug: Annotated[str, cyclopts.Parameter(help='A block type slug')])

Display details about a block type.

blocktype_delete ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/block.py#L583" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

blocktype_delete(slug: Annotated[str, cyclopts.Parameter(help='A Block type slug')])

Delete an unprotected Block Type.