当前位置：首页 > news >正文

5分钟上手zx：让JavaScript成为你的系统脚本利器

news 2026/5/12 10:57:23

5分钟上手zx：让JavaScript成为你的系统脚本利器

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

在现代开发流程中，自动化脚本是提升效率的关键。zx作为一款由Google开发的开源工具，将JavaScript的灵活性与系统命令的强大功能完美结合，让开发者告别繁琐的Bash脚本，用熟悉的JS语法轻松编写自动化任务。本文将带你快速掌握zx的核心功能，从安装配置到实战应用，全方位提升你的开发效率。

zx：重新定义脚本编写体验

zx（全称"A tool for writing better scripts"）是一个旨在简化系统脚本编写的工具。它解决了传统Bash脚本在复杂逻辑处理上的不足，同时消除了Node.js原生脚本处理系统命令时的样板代码冗余。通过提供简洁的API和自动转义功能，zx让开发者能够用JavaScript编写强大的系统脚本，大幅降低自动化配置的复杂度。

核心优势解析

语法熟悉度：使用JavaScript语法，降低学习成本
命令简化：通过$函数轻松执行系统命令
内置工具丰富：集成文件操作、HTTP请求等常用功能
跨平台兼容：支持Linux、macOS、Windows等多种操作系统
多运行时支持：兼容Node.js、Bun、Deno等主流JS运行时

快速部署：5分钟完成zx环境配置

支持环境要求

操作系统：Linux、macOS、Windows
JavaScript运行时：Node.js (≥12.17.0)、Bun (≥1.0.0)、Deno (1.x/2.x)
终端环境：Bash、PowerShell等

多种安装方式对比

npm安装（推荐）

# 本地安装 npm install zx # 全局安装 npm install -g zx

npx临时运行

# 无需安装直接运行脚本 npx zx script.js # 指定特定版本 npx zx@8.6.0 script.js

其他包管理器

# Yarn yarn add zx # PNPM pnpm add zx # Bun bun install zx

Docker方式

docker pull ghcr.io/google/zx:8.5.0 docker run -t ghcr.io/google/zx:8.5.0 -e="await \$({verbose: true})\`echo hello\`"

从零开始：编写你的第一个zx脚本

基础脚本结构

创建一个扩展名为.mjs的文件（例如first-script.mjs），添加以下内容：

#!/usr/bin/env zx // 执行系统命令 await $`echo "Hello, zx!"` // 变量插值（自动转义特殊字符） const projectName = 'zx-demo' await $`mkdir /tmp/${projectName}` // 并行执行多个命令 await Promise.all([ $`sleep 1; echo 任务1完成`, $`sleep 2; echo 任务2完成`, $`sleep 3; echo 任务3完成`, ]) console.log(chalk.green('所有任务执行完毕！'))

运行脚本的两种方式

直接执行（需要可执行权限）

chmod +x ./first-script.mjs ./first-script.mjs

通过zx命令执行

zx ./first-script.mjs

核心功能详解：提升脚本编写效率

命令执行与结果处理

zx的$函数是执行系统命令的核心，它返回一个ProcessPromise对象，可以使用await获取结果：

// 获取当前Git分支 const branch = await $`git branch --show-current` console.log(`当前分支: ${branch.stdout.trim()}`)

完善的错误处理机制：

try { await $`exit 1` } catch (p) { console.log(`命令执行失败，退出码: ${p.exitCode}`) console.log(`错误信息: ${p.stderr}`) }

内置全局工具函数

zx提供了多种无需额外导入的内置工具函数：

文件系统操作：基于fs-extra的fs模块
路径处理：path模块
HTTP请求：fetch函数
颜色输出：chalk模块
睡眠函数：sleep函数

示例：文件操作与网络请求

// 创建目录并写入文件 await fs.mkdirp('/tmp/zx-example') await fs.writeFile('/tmp/zx-example/info.txt', '使用zx简化脚本编写') // 读取文件内容 const content = await fs.readFile('/tmp/zx-example/info.txt', 'utf8') // 发起HTTP请求 const response = await fetch('https://api.github.com/users/google') const data = await response.json() console.log(`公司名称: ${data.name}`)

高级应用：定制你的zx开发环境

显式导入全局变量

虽然zx默认提供全局函数，但在某些情况下你可能需要显式导入：

// 导入所有全局变量 import 'zx/globals' // 或按需导入 import { $, fs, path, chalk } from 'zx'

切换shell环境

默认情况下，zx使用bash执行命令，你可以切换到PowerShell：

import { usePowerShell, useBash } from 'zx' usePowerShell() // 切换到PowerShell // useBash() // 切回bash

TypeScript支持

zx原生支持TypeScript，创建.ts文件并添加类型定义：

import { $, ProcessOutput } from 'zx' async function getGitBranch(): Promise<string> { const branch: ProcessOutput = await $`git branch --show-current` return branch.stdout.trim() } console.log(`当前分支: ${await getGitBranch()}`)

实战案例：zx自动化脚本应用场景

1. 项目构建自动化脚本

#!/usr/bin/env zx // 检查Node.js版本 const nodeVersion = await $`node -v` if (!nodeVersion.stdout.startsWith('v18.')) { console.error(chalk.red('需要Node.js 18.x版本')) process.exit(1) } console.log(chalk.blue('开始项目构建...')) // 安装依赖 await $`npm install` // 运行测试 await $`npm test` // 构建项目 await $`npm run build` console.log(chalk.green('构建完成！'))

2. 多环境部署脚本

#!/usr/bin/env zx const env = process.argv[3] || 'dev' const config = require(`./config/${env}.json`) console.log(chalk.blue(`部署到${env}环境...`)) // 拉取最新代码 await $`git pull origin main` // 安装依赖 await $`npm ci` // 构建项目 await $`npm run build:${env}` // 部署到服务器 await $`scp -r dist/* ${config.server.user}@${config.server.host}:${config.server.path}` console.log(chalk.green(`成功部署到${env}环境`))