Tool

Provides functions to register toolbelt webivew tools.

async async_register_web_view_tool(connection: iterm2.connection.Connection, display_name: str, identifier: str, reveal_if_already_registered: bool, url: str) → None

Registers a toolbelt tool that shows a webview.

Parameters

  • connection (Connection) – The connection to iTerm2.

  • display_name (str) – The name of the tool. User-visible.

  • identifier (str) – A unique ID for this tool. Only one tool with a given identifier may be registered at a time.

  • reveal_if_already_registered (bool) – If True, shows the tool on a duplicate registration attempt.

  • url (str) – The URL to show in the webview.

Throws

RPCException if something goes wrong

See also

Example “Targeted Input”

Indices and tables