structure_import()

Save an existing folder's layout as a private structure on Framework Cloud.

The folders are scanned and mapped as in adopt(), and you review the mapping the same way. Only the confirmed folder paths are sent: never file names or contents.

Usage

structure_import(
    path: str | Path = '.',
    name: str | None = None,
    yes: bool = False,
) -> dict[str, Any]

Arguments

Name	Type	Default	Description
path	str \| Path	'.'	The project folder.
name	str \| None	None	The structure's name. Default: the folder's name.
yes	bool	False	Send the proposed mapping without asking, as a script must.

Value

The new structure: key ("<owner>/<key>"), name, and url.

Raises

CloudError: When you are not logged in, or the server rejects the layout or doesn't support structures.
FrameworkError: When the review needs a terminal and yes is False, or when you cancel it.