Skip to content
Back to top
View this page

# mindroot.coreplugins.index.handlers package

## Submodules

## mindroot.coreplugins.index.handlers.agent_ops module

async mindroot.coreplugins.index.handlers.agent_ops.add_agent(INDEX_DIR: Path, index_name: str, agent: AgentEntry)

  Add an agent to an index

async mindroot.coreplugins.index.handlers.agent_ops.remove_agent(INDEX_DIR: Path, index_name: str, agent_name: str)

  Remove an agent from an index

## mindroot.coreplugins.index.handlers.index_ops module

async mindroot.coreplugins.index.handlers.index_ops.create_index(INDEX_DIR: Path, metadata: IndexMetadata)

  Create a new index directory with metadata

async mindroot.coreplugins.index.handlers.index_ops.list_indices(INDEX_DIR: Path)

  List all available indices

async mindroot.coreplugins.index.handlers.index_ops.update_index(INDEX_DIR: Path, index_name: str, metadata: IndexMetadata)

  Update index metadata

## mindroot.coreplugins.index.handlers.plugin_ops module

async mindroot.coreplugins.index.handlers.plugin_ops.add_plugin(INDEX_DIR: Path, index_name: str, plugin: PluginEntry)

  Add a plugin to an index

async mindroot.coreplugins.index.handlers.plugin_ops.create_distributable_entry(plugin: PluginEntry) → dict

  Transform plugin entry to distributable format

async mindroot.coreplugins.index.handlers.plugin_ops.get_installed_plugin_metadata(plugin_name: str) → dict

  Get metadata from main plugin manifest

async mindroot.coreplugins.index.handlers.plugin_ops.remove_plugin(INDEX_DIR: Path, index_name: str, plugin_name: str)

  Remove a plugin from an index

## mindroot.coreplugins.index.handlers.publish module

async mindroot.coreplugins.index.handlers.publish.install_index_from_zip(INDEX_DIR: Path, file: UploadFile)

  Install an index from a zip file.

async mindroot.coreplugins.index.handlers.publish.publish_index(INDEX_DIR: Path, PUBLISHED_DIR: Path, index_name: str)

  Publish an index by creating a zip file containing index.json and persona directories.

## Module contents

async mindroot.coreplugins.index.handlers.add_agent(INDEX_DIR: Path, index_name: str, agent: AgentEntry)

  Add an agent to an index

async mindroot.coreplugins.index.handlers.add_plugin(INDEX_DIR: Path, index_name: str, plugin: PluginEntry)

  Add a plugin to an index

async mindroot.coreplugins.index.handlers.create_index(INDEX_DIR: Path, metadata: IndexMetadata)

  Create a new index directory with metadata

async mindroot.coreplugins.index.handlers.install_index_from_zip(INDEX_DIR: Path, file: UploadFile)

  Install an index from a zip file.

async mindroot.coreplugins.index.handlers.list_indices(INDEX_DIR: Path)

  List all available indices

async mindroot.coreplugins.index.handlers.publish_index(INDEX_DIR: Path, PUBLISHED_DIR: Path, index_name: str)

  Publish an index by creating a zip file containing index.json and persona directories.

async mindroot.coreplugins.index.handlers.remove_agent(INDEX_DIR: Path, index_name: str, agent_name: str)

  Remove an agent from an index

async mindroot.coreplugins.index.handlers.remove_plugin(INDEX_DIR: Path, index_name: str, plugin_name: str)

  Remove a plugin from an index

async mindroot.coreplugins.index.handlers.update_index(INDEX_DIR: Path, index_name: str, metadata: IndexMetadata)

  Update index metadata