install_skill()
Install a SKILL.md file for AI coding agents.
Usage
install_skill(
*,
package=None,
url=None,
skill_content=None,
agent=None,
global_=False,
path=None,
root=None,
detect=False,
skill_name=None,
extra_files=None,
quiet=False
)Resolves skill content from one of three sources (in priority order):
skill_content: raw SKILL.md text provided directlyurl: fetch from a documentation siteโs well-known endpointpackage: find bundled skills inside an installed Python package
The skill is installed to the appropriate agent directory based on auto-detection or explicit agent parameter.
Parameters
package: str | None = None-
Python package name (e.g.,
"great-tables"). Skills are looked up inside the installed packageโsskills/directory. url: str | None = None-
Documentation site URL to fetch skills from via the
.well-knowndiscovery protocol. skill_content: str | None = None-
Raw SKILL.md content to install directly.
agent: AgentFormat | None = None-
Target agent format. If not set, auto-detected from the project root or prompted interactively.
global_: bool = False-
Install to the global (home directory) location instead of the repo.
path: str | None = None-
Explicit target path. Overrides agent-based path resolution.
root: Path | None = None-
Project root directory. Defaults to the current working directory.
detect: bool = False-
Auto-detect existing installations and update them in place.
skill_name: str | None = None-
Override the skill name (derived from frontmatter by default).
extra_files: dict[str, str] | None = None-
Additional files to install alongside SKILL.md, as
{relative_path: content}pairs. quiet: bool = False- Suppress output messages.
Returns
list[Path]- Paths to installed SKILL.md files (one per agent if multiple detected).