@ git- file system/ github (英语)
此套件包含 GitHub 执行 git 文件系统 npm 软件包.
使用此选项只读取到 GitHub 寄存器; 否则使用 git 文件系统 将软件包写入多个云提供方托管的寄存器.
该套件暴露了下列方法:
-
创建仓库
-
删除寄存器
-
搜索仓库
-
创建文件
-
覆盖文件
-
删除文件
-
创建标签
-
从标签读取文件
安装
npm install @git-filesystem/github
示例使用
import { GitHubClient } from "@git-filesystem/github";
const gitHubClient = new GitHubClient("github-username", "access-token", "user-agent-name");
const gitHubRepository = gitHubClient.getRepository("repository-name");
let fileContent = await gitHubRepository.readFile("file/path.txt");
fileContent += "\n\nNewData";
await gitHubRepository.updateFile("file/path.txt", fileContent);
许可证
@git-filesystem/github 许可使用此程序 ISC 许可证。 。 。 .
关于 @git-filesystem/github 的常见问题
@git-filesystem/github 是什么?
Git-file系统包使用的 GitHub 执行 。 使用此选项只读取到 GitHub 寄存器 .
如何安装 @git-filesystem/github?
在项目目录运行 npm install @git-filesystem/github,或使用 pnpm add / yarn add / bun add。
@git-filesystem/github 支持 TypeScript 吗?
支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。
@git-filesystem/github 支持 ESM 还是 CommonJS?
以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。
@git-filesystem/github 可以商用吗?
@git-filesystem/github 使用 ISC 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。
@git-filesystem/github 的下载量有多少?
根据 npm 官方下载统计,@git-filesystem/github 在 2026/10/17 – 2026/11/15 这 30 天内被下载 2,646 次,日均约 88 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。
@git-filesystem/github 还在维护吗?
最新版本 0.0.6 发布于 2024/03/04(2 年前);至今共发布 6 个版本,其中过去 12 个月发布了 0 个;首次发布于 2022/10/24。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。