plan_skill_install

ansys.mapdl.core.cli.skills.plan_skill_install(skill_name, env, scope='local', skills_dir=None)

Resolve the file operations needed to install a skill.

Nothing is written to disk. Pass the result to apply_skill_install() to perform the installation.

Parameters:

skill_namestr

Skill identifier, as reported by list_skills().

envstr

AI coding environment. One of SUPPORTED_ENVS.

scopestr, default: “local”

Either "local" to install into the current working directory, or "global" to install into the home directory of the user.

skills_dirpathlib.Path, optional

Directory holding one sub-directory per skill. Defaults to the directory bundled with the package.

Returns:

SkillInstallPlan

The files that are created or updated by the installation.

Raises:

UnknownSkillError

When skill_name is not bundled with PyMAPDL.

UnsupportedScopeError

When env does not support scope.

ValueError

When env is not a supported environment.

Return type:

SkillInstallPlan

Examples

Inspect what a local Claude installation would do:

>>> from ansys.mapdl.core.cli.skills import plan_skill_install
>>> print(plan_skill_install("pymapdl-cli", "claude").summary)