Backplane.SkillProtocol.Bundle (backplane_skill_protocol v0.8.0)

Copy Markdown

Bounded inspection, packing, and atomic preparation of complete Skill bundles.

Summary

Types

t()

Functions

artifact_digest(bytes)
inspect(path_or_upload, opts \\ [])
pack(skill_root, archive_path, opts \\ [])
prepare(path_or_bundle, destination, opts \\ [])

Types

t()

@type t() :: %Backplane.SkillProtocol.Bundle{
  archive_path: term(),
  document: term(),
  files: term(),
  manifest: term(),
  meta: term()
}

Functions

artifact_digest(bytes)

inspect(path_or_upload, opts \\ [])

@spec inspect(
  String.t() | %{path: String.t()},
  keyword()
) :: {:ok, t()} | {:error, Backplane.SkillProtocol.Error.t()}

pack(skill_root, archive_path, opts \\ [])

@spec pack(String.t(), String.t(), keyword()) ::
  {:ok, t()} | {:error, Backplane.SkillProtocol.Error.t()}

prepare(path_or_bundle, destination, opts \\ [])

@spec prepare(String.t() | %{path: String.t()} | t(), String.t(), keyword()) ::
  {:ok, Backplane.SkillProtocol.PreparedSkill.t()}
  | {:error, Backplane.SkillProtocol.Error.t()}