跳转到主要内容

CLI命令

以下是在@grafana/create-plugin中可用的命令。

create-plugin​

使用create-plugin命令来构建您的插件。

npx @grafana/create-plugin@latest

运行create-plugin命令时，会出现以下提示

选择插件类型​

? Select a plugin type …
❯ App (add custom pages, UI extensions and bundle other plugins)
  Data source (query data from a custom source)
  Panel (add a visualization for data or a widget)
  App with Scenes (create dynamic dashboards in app pages)

有关各种插件类型的更多信息，请参阅Grafana插件类型和用法。

有关Scenes如何允许您在应用插件中创建类似仪表板体验的更多信息，请参阅Scenes文档。

添加后端以支持服务器端功能？(是/N)​

如果您正在创建应用或数据源插件，您将被要求是否要另外添加后端组件。

后端插件提供强大的功能，例如

  • 为数据源启用Grafana警报。
  • 连接浏览器通常无法连接的非HTTP服务。例如，SQL数据库服务器。
  • 在用户之间保持状态。例如，数据源查询缓存。
  • 使用Grafana不支持的自定义身份验证方法和/或授权检查。
  • 使用自定义数据源请求代理。

有关更多信息，请参阅后端插件。

输入您的插件名称​

为您的插件起一个有助于识别其用途的名称。

输入您的组织名称（通常是您的 Grafana Cloud 组织）​

输入您的组织名称。这必须是您的 Grafana Cloud 组织。通过组织名称，您可以 签名 并可选择将插件 发布 到 Grafana 插件目录。

跳过提示​

您可以使用 create-plugin 命令行参数跳过所有前面的提示。要使用 CLI 参数搭建插件，请像这样传递参数给 create-plugin 命令

npx @grafana/create-plugin \
  --plugin-type="app" \
  --plugin-name="myPlugin" \
  --org-name="myorg" \
  --backend

您可以使用 CLI 参数快速搭建插件。使用参数还可以让您在非交互式环境中运行工具，例如 CI，或使用其他工具搭建插件。

参阅以下表格以获取跳过提示的完整列表

提示等效参数名称值
插件类型--plugin-type其中之一 app、datasource、panel 或 scenesapp
后端--backend / --no-backend布尔值
名称--plugin-name字符串
组织--org-name字符串

更新​

要将现有插件更新为使用最新的 create-plugin 工具版本，请从插件的根目录运行以下命令

npx @grafana/create-plugin@latest update

此命令将更新以下内容

  • /.config - 构建插件的配置文件
  • NPM 依赖项 - 依赖项（主要用于支持最新的 Grafana 版本和构建更新）
  • NPM 脚本 - 与构建相关的脚本中的任何更新

update --force​

默认情况下，如果存储库中有未提交的更改，则 update 命令将停止。如果您想强制更新，请使用 --force 标志

npx @grafana/create-plugin@latest update --force