skill.install

skill.install(key, *, agent_targets=None, scope='project', copy=False, force=False, project_dir=None, store=None)[source]

Install a skill into one or more agent target directories.

Returns a dict mapping agent target names to the paths where the skill was installed.

Parameters:
  • key (str) – Canonical skill key (e.g., 'owner/skill-name').

  • agent_targets (list[str] | None) – Agent targets to install into. Defaults to config’s default_agent_targets.

  • scope (str) – 'project' (default) or 'global'.

  • copy (bool) – If True, copy instead of symlink.

  • force (bool) – If True, overwrite existing files/links.

  • project_dir (Path | str | None) – Project root. Auto-detected if None.

  • store (LocalSkillStore | None) – Skill store to read from. Uses default if None.

Return type:

dict[str, Path]