# @devframes/plugin-git 中文文档

规范地址：https://npmcn.com/package/%40devframes/plugin-git/

版本：1\.3\.3
npm 元数据更新时间：2026-11-10T08:38:47.772Z
中文译文更新时间：2026-11-12T07:07:05.208Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40devframes/plugin-git
原文对照：https://npmcn.com/package/%40devframes/plugin-git/?lang=original
项目主页：https://github.com/devframes/devframe#readme
源码仓库：https://github.com/devframes/devframe

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：12.7 kB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：5 个
- peer 依赖：@devframes/plugin-git--assets 1\.3\.3
- 首次发布：2026-07-06T05:08:49.705Z
- 最新版本发布：2026-11-10T08:38:47.141Z
- 近 30 天下载量：2715（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：68（近 12 个月 68 个）

## 中文简介

显示状态、日志、分行和diffs的 Git 仪表板的 Devframe 插件 .

## 安装

```sh
npm install @devframes/plugin-git
```

也可以使用：`pnpm add @devframes/plugin-git`、`yarn add @devframes/plugin-git`、`bun add @devframes/plugin-git`

## README

# @devframes/plugin-git (英语)

> 实验 这个devframe是实验性的,可能会在不发生重大版本突起的情况下改变,直到 它稳定.

一个基于 [副总裁](https://github.com/devframes/devframe)(单位:千美元) 装有存储器的仪表板 **Next.js App 路由器 + shadcn/ui** SPA 结束 类型安全 RPC. 节点外壳 `git` 并揭露存放处; 同样的捆绑与活式dev服务器或全静态部署一样运行.

状态, sourceTree 风格 **承诺图**树枝和起落架, 毫不动摇,承诺,所有通过共享 [`@devframes/service-git`](https://npmcn.com/package/services/git) 电讯服务. UI跟随 系统 **轻/暗** 使用手动切换.

## 安装

```sh
npm i -D @devframes/plugin-git
```

## 独立的CLI

运行当前仓库的仪表板 :

```sh
pnpx @devframes/plugin-git         # dev server (live RPC over WebSocket)
pnpx @devframes/plugin-git build   # static deploy → dist-static/
pnpx @devframes/plugin-git --port 4000
```

## 程序化

`createGitDevframe(options)` 返回您可以挂起的编程定义 任何带有devframe适配器的宿主框架,或自行驱动.

```ts
import { createGitDevframe } from '@devframes/plugin-git'
import { createCac } from 'devframe/adapters/cac'

await createCac(createGitDevframe({
  repoRoot: process.cwd()
})).parse()
```

| 选项 | 默认 | 说明 |
| --- | --- | --- |
| `repoRoot` | 编辑器 `cwd` | 要检查的仓库目录 . |
| `basePath` | 适配器已解析 | 挂载路径( M)`/` 独立, `/__git/` (电话:(212) 963-9730). |
| `distDir` | 捆绑的SPA | 覆盖已送达的 SPA 目录 . |
| `port` | `9710` | 首选 dev- server 端口 . |

## 难民保护委员会

所有的工作都贯穿于 [`@devframes/service-git`](https://npmcn.com/package/services/git) 电讯服务,本论坛宣布`services`及其最高人民会议呼吁 直接过 `devframes:service:git:*`。读取的函数是: `query` 降解为空的函数, `isRepo: false` 基特以外的结果 寄存器;定义通过 `rpc.snapshot` (在Dev的WebSocket上解析后直播,服务于建设时的快照) 静态部署).

-   `devframes:service:git:status`:分支,上游跟踪(头/后),已上演/未上演/ 未跟踪文件, 解析自 `git status --porcelain=v2`。 。 。 .
-   `devframes:service:git:log`: 已承诺的历史(`limit` 编号 : `skip`包括父母关系 {\\fn黑体\\fs22\\bord1\\shad0\\3ahbe\\4ah00\\fscx67\\fscy66\\2chffffff\\3ch808080}这能推动犯罪图.
-   `devframes:service:git:branches`: 有 SHA 的地方分会,上游分会,前行/后行分会,尖口分会.
-   `devframes:service:git:diff`: 工作树或索引的每个文件添加/删除的计数,加 选定文件的统一补丁.

写入动作是 `action` 函数,总是被服务所曝光,并带有 写入受连接-信任边界制约的授权。 每个 返回新状态( 承诺返回结果) :

-   `devframes:service:git:stage`数字 : `git add` 给定的路径.
-   `devframes:service:git:unstage`数字 : `git restore --staged` 给定的路径.
-   `devframes:service:git:commit`: 以信息执行已播放的更改 .

## 开发

```sh
pnpm -C plugins/git dev     # client (Next.js HMR) + RPC backend together
pnpm -C plugins/git build   # tsdown (node) + next build (SPA) → dist/
```

`pnpm dev` 启动 Next.js dev 服务器( 带有热重装) 和 deframe RPC/WebSocket同时后端,再打印出两个URL;打开UI一. SPA 连接到WebSocket端口上的后端 `NEXT_PUBLIC_DEVFRAME_WS`替换端口 `PORT` (UI)和 `DEVFRAME_GIT_PORT` (后发. 单侧运行 `dev:client` 或者说 `dev:server`。 。 。 .

SPA是标准shadcn/ui设置(Tailwind v4), `components/ui/*`) (中文(简体) ). 三个 下一个.js 设置在 `app/next.config.mjs` 保持便携式: `output: 'export'` (devframe拥有服务器), `assetPrefix: '.'` (相对资产如此) 同一捆绑在任何基地工作),以及 `trailingSlash: true` (编) devframe的静态目录-有索引分辨率).

## 常见问题

### @devframes/plugin-git 是什么？

显示状态、日志、分行和diffs的 Git 仪表板的 Devframe 插件 \.

### 如何安装 @devframes/plugin-git？

在项目目录运行 npm install @devframes/plugin-git，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 devframe-git，可以用 npx devframe-git 直接运行。

### @devframes/plugin-git 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @devframes/plugin-git 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @devframes/plugin-git 可以商用吗？

@devframes/plugin-git 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @devframes/plugin-git 的下载量有多少？

根据 npm 官方下载统计，@devframes/plugin-git 在 2026/10/12 – 2026/11/10 这 30 天内被下载 2,715 次，日均约 91 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @devframes/plugin-git 还在维护吗？

最新版本 1\.3\.3 发布于 2026/11/10（1 天前）；至今共发布 68 个版本，其中过去 12 个月发布了 68 个；首次发布于 2026/07/06。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。