实战教程:10行代码用zx构建交互式GitHub仓库自动备份脚本
2026/9/3 11:49:14 网站建设 项目流程

实战教程:10行代码用zx构建交互式GitHub仓库自动备份脚本

【免费下载链接】zxA tool for writing better scripts项目地址: https://gitcode.com/GitHub_Trending/zx/zx

zx是一款"编写更好脚本"的工具(A tool for writing better scripts),它让你在 Shell 中直接使用 JavaScript:命令用模板字符串执行,参数自动转义,还支持await、循环、条件判断和交互式输入。本文将带你用不到 10 行核心代码,写一个可以问答交互、自动备份 GitHub 仓库的脚本,新手也能轻松上手。

为什么选择 zx 脚本工具?

传统 Bash 脚本写多了条件判断、JSON 处理就会变得难读。而 zx 把 Node.js 的能力直接搬进命令行:

  • 零样板代码$fetchquestioncd等全局函数开箱即用,无需 import
  • 参数自动转义$mkdir ${name}`` 即使变量含空格、特殊字符也不会出错
  • 跨平台:Linux、macOS、Windows 均可运行,兼容 Node.js、Bun、Deno
  • 交互式能力:内置 question 函数,一行代码就能向用户提问,还支持选项补全

快速安装:一条命令搞定

先拿到项目代码(仓库为只读,仅作学习使用):

git clone https://gitcode.com/GitHub_Trending/zx/zx

然后安装 zx,详见官方安装文档 docs/setup.md:

npm install zx

装好后,任何以.mjs结尾、首行带#!/usr/bin/env zx的脚本都能直接执行,快速入门细节可参考 docs/getting-started.md。

10行代码看懂交互式备份脚本

核心逻辑非常直白,分三步:(交互式获取用户名)→(调用 API 拉取仓库列表)→(逐个git clone到本地)。

#!/usr/bin/env zx // backup.mjs const username = await question('请输入你的 GitHub 用户名: ') const res = await fetch(`https://api.github.com/users/${username}/repos?per_page=100`, { headers: { Authorization: `token ${process.env.GITHUB_TOKEN}` }, }) const repos = await respos = await res.json() await $`mkdir -p backups` cd('./backups') for (const repo of repos) { await $`git clone ${repo.git_url.replace('git://github.com/', 'git@github.com:')}` } log(`✅ 共备份 ${repos.length} 个仓库到 ./backups`)

逐行拆解:

代码作用
await question('...')暂停脚本,等用户在终端输入,回车后继续
fetch(...)全局 fetch 请求仓库列表,带 Token 可查私有仓库
await $mkdir -p backups``模板字符串执行 Shell 命令,失败自动抛错
cd('./backups')切换工作目录,后续克隆都落在 backups 下
for + git cloneJS 循环遍历仓库,逐个克隆

官方仓库里有一个带 Token 选择的完整版本,可对照阅读:examples/backup-github.mjs。它用questionchoices选项把环境变量列成菜单,让用户直接点选 Token 名称,交互体验更好。

运行交互式备份脚本

export GITHUB_TOKEN=ghp_xxxxxxxx # 可选,私有仓库需要 zx backup.mjs

运行后终端会先弹出手动问答,输入用户名回车,脚本自动开始克隆,最后打印备份数量。执行方式还有node --import zx/globals backup.mjs等多种写法,见 docs/cli.md。

进阶技巧:让脚本更强

  • 并行克隆:用Promise.all(urls.map(u => $git clone ${u}))同时拉取多个仓库,速度提升明显,参考 examples/parallel.mjs
  • 程序化交互for await (const chunk of p.stdout)监听子进程输出并自动喂入答案,实现无人值守,参考 examples/interactive.mjs
  • Markdown 脚本:直接把命令写进.md文件,zx docs/xxx.md即可运行,适合写"文档即脚本"的 Runbook

总结

借助 zx 脚本工具,交互式输入、API 请求、Shell 命令融合在一段 JavaScript 里,10 行代码就完成了 GitHub 仓库自动备份脚本。相比纯 Bash,它更易读、易维护、跨平台,是运维自动化和 DevOps 脚本的优选。从 examples/ 目录里多翻几个示例,你很快就能写出属于自己的自动化脚本。

【免费下载链接】zxA tool for writing better scripts项目地址: https://gitcode.com/GitHub_Trending/zx/zx

创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考

需要专业的网站建设服务?

联系我们获取免费的网站建设咨询和方案报价,让我们帮助您实现业务目标

立即咨询