> ## Documentation Index
> Fetch the complete documentation index at: https://starforge.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# sf plugin

> 插件中心：发布、安装、锁定与治理

工作流讲解见[插件中心](/zh-Hans/extend/overview)。

## 浏览

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
sf plugin ls                        # 平台上的插件
sf plugin info <owner>/<name>       # manifest、版本历史、digest
```

## 安装与锁定

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
sf plugin install <owner>/<name>                # 下载到本地 forge_plugins/（缺省最新版）
sf plugin install <owner>/<name> --exp my-grpo  # 锁定到实验 plugins.lock.json
sf plugin remove <owner>/<name> --exp my-grpo   # 从实验锁移除引用
```

| `install` 选项 | 说明                              |
| ------------ | ------------------------------- |
| `-e, --exp`  | 锁定到该实验：提交时随 JobSpec 引用，由平台注入作业包 |

## 发布

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
sf plugin publish ./my-plugin                 # 目录内须有 plugin.yaml
sf plugin publish ./my-plugin --owner team-x  # admin 可跨命名空间
```

发布时校验：入口模块存在、不占用保留顶层名、包大小预检。**版本不可变**——迭代发新版本。

## 治理（admin）

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
sf plugin disable <owner>/<name>    # 新作业不可引用；历史记录保留
sf plugin enable <owner>/<name>
```

## `sf plugin`

Manage plugins

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
sf plugin <subcommand>
```

| 命令                  | 说明                                 |
| ------------------- | ---------------------------------- |
| `sf plugin disable` | Disable a plugin                   |
| `sf plugin enable`  | Enable a plugin (admin)            |
| `sf plugin info`    | Show a plugin's details            |
| `sf plugin install` | Install a plugin                   |
| `sf plugin ls`      | List the plugins on the platform   |
| `sf plugin publish` | Publish a plugin version           |
| `sf plugin remove`  | Remove a plugin from an experiment |

### `sf plugin disable`

Disable a plugin

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
sf plugin disable <REF>
```

| 参数    | 说明                                              |
| ----- | ----------------------------------------------- |
| `REF` | Plugin id: \<owner>/\<name>\[@version] (**必填**) |

除 `--help` 外没有其他选项。

### `sf plugin enable`

Enable a plugin (admin)

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
sf plugin enable <REF>
```

| 参数    | 说明                                              |
| ----- | ----------------------------------------------- |
| `REF` | Plugin id: \<owner>/\<name>\[@version] (**必填**) |

除 `--help` 外没有其他选项。

### `sf plugin info`

Show a plugin's details

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
sf plugin info <REF>
```

| 参数    | 说明                                              |
| ----- | ----------------------------------------------- |
| `REF` | Plugin id: \<owner>/\<name>\[@version] (**必填**) |

除 `--help` 外没有其他选项。

### `sf plugin install`

Install a plugin

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
sf plugin install <REF> [options]
```

| 参数    | 说明                                                                      |
| ----- | ----------------------------------------------------------------------- |
| `REF` | Plugin id: \<owner>/\<name>\[@version], defaults to the latest (**必填**) |

| 选项            | 说明                                                                                                                   |
| ------------- | -------------------------------------------------------------------------------------------------------------------- |
| `--exp`, `-e` | Lock it to this experiment: referenced with the JobSpec on submission, injected into the job package by the platform |

### `sf plugin ls`

List the plugins on the platform

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
sf plugin ls
```

除 `--help` 外没有其他选项。

### `sf plugin publish`

Publish a plugin version

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
sf plugin publish <PATH> [options]
```

| 参数     | 说明                        |
| ------ | ------------------------- |
| `PATH` | Plugin directory (**必填**) |

| 选项        | 说明                                                                          |
| --------- | --------------------------------------------------------------------------- |
| `--owner` | Target namespace (only an admin can cross namespaces; defaults to your own) |

### `sf plugin remove`

Remove a plugin from an experiment

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
sf plugin remove <REF> [options]
```

| 参数    | 说明                                   |
| ----- | ------------------------------------ |
| `REF` | Plugin id: \<owner>/\<name> (**必填**) |

| 选项            | 说明                               |
| ------------- | -------------------------------- |
| `--exp`, `-e` | Experiment name or path (**必填**) |