Migration from v7 to v8
v8.0.0 release brought many features, improvements, optimizations and fixes, but also has introduced a few breaking changes. Fortunately, everything can be restored and legacy v7 scripts can still run with minor configurations.
$.verbose
is set tofalse
by default, but errors are still printed tostderr
. Set$.quiet = true
to suppress any output.
js
$.verbose = true // everything works like in v7
$.quiet = true // to completely turn off logging
ssh
API was dropped. Install webpod package instead.
js
// import {ssh} from 'zx' ↓
import {ssh} from 'webpod'
const remote = ssh('user@host')
await remote`echo foo`
- zx is not looking for
PowerShell
anymore, on Windows by default. If you still need it, use theusePowerShell
helper to enable:
js
import { usePowerShell, useBash } from 'zx'
usePowerShell() // to enable powershell
useBash() // switch to bash, the default
To look for modern PowerShell v7+, invoke usePwsh()
helper instead:
js
import { usePwsh } from 'zx'
usePwsh()
- Process cwd synchronization between
$
invocations is now disabled by default. This functionality is provided via an async hook and can now be controlled directly.
js
import { syncProcessCwd } from 'zx'
syncProcessCwd() // restores legacy v7 behavior
🚀
Keep in mind, v7 is in maintenance mode, so it will not receive any new enhancements. We encourage you to upgrade to the latest: it's 16x smaller, faster, safer, more reliable and useful in a wider range of practical scenarios.