DEV Community

Lam
Lam

Posted on

3 2

Shell.Js Cheat Sheet

Also see

Utils

sh.which('x')
sh.pwd()
Enter fullscreen mode Exit fullscreen mode
sh.echo('hi')
Enter fullscreen mode Exit fullscreen mode
sh.exec('node --version').code
sh.exec('node --version').output
sh.exec('node --version', { silent: true }).output
Enter fullscreen mode Exit fullscreen mode
sh.exec('node --version', (code, output) => {
  sh.echo(`exit code ${code}`)
})
Enter fullscreen mode Exit fullscreen mode
sh.tempdir()
Enter fullscreen mode Exit fullscreen mode
sh.error()  // null if no error
Enter fullscreen mode Exit fullscreen mode

Cat and output

src = sh.cat('file*.txt')
Enter fullscreen mode Exit fullscreen mode
'hello'.to('output.txt')
'hello'.toEnd('append.txt')
Enter fullscreen mode Exit fullscreen mode
sh.cat('input.txt').to('output.txt')
Enter fullscreen mode Exit fullscreen mode

Tests

sh.test('-b', 'path')  // block device
sh.test('-d', 'path')  // dir
sh.test('-e', 'path')  // exists
sh.test('-f', 'path')  // file
sh.test('-L', 'path')  // symlink
Enter fullscreen mode Exit fullscreen mode

File manipulation

sh.cp('src', 'dest')
sh.cp('-rf', 'src', 'dest')
Enter fullscreen mode Exit fullscreen mode
sh.rm('file')
sh.rm('-rf', 'file')
Enter fullscreen mode Exit fullscreen mode
sh.mv('src', 'dest')
sh.mv(['src1','src2'], 'dest')
Enter fullscreen mode Exit fullscreen mode
sh.chmod('644', 'file')
sh.chmod(755, 'file')
sh.chmod('u+x', 'file')
Enter fullscreen mode Exit fullscreen mode

Paths

sh.cd('dir')
Enter fullscreen mode Exit fullscreen mode
sh.mkdir('dir')
sh.mkdir('-p', 'dir')
Enter fullscreen mode Exit fullscreen mode

Require

const sh = require('shelljs')
Enter fullscreen mode Exit fullscreen mode

Example

var shell = require('cs/shelljs')
Enter fullscreen mode Exit fullscreen mode
if (!shell.which('git')) {
  shell.echo('Sorry, this script requires git')
  shell.exit(1)
}
Enter fullscreen mode Exit fullscreen mode
// Copy files to release dir
shell.rm('-rf', 'out/Release')
shell.cp('-R', 'stuff/', 'out/Release')
Enter fullscreen mode Exit fullscreen mode
// Replace macros in each .js file
shell.cd('lib')
shell.ls('*.js').forEach(function (file) {
  shell.sed('-i', 'BUILD_VERSION', 'v0.1.2', file)
  shell.sed('-i', /^.*REMOVE_THIS_LINE.*$/, '', file)
  shell.sed('-i', /.*REPLACE_LINE_WITH_MACRO.*\n/, shell.cat('macro.js'), file)
})
shell.cd('..')
Enter fullscreen mode Exit fullscreen mode
// Run external tool synchronously
if (shell.exec('git commit -am "Auto-commit"').code !== 0) {
  shell.echo('Error: Git commit failed')
  shell.exit(1)
}
Enter fullscreen mode Exit fullscreen mode

Taken from the Readme.

Sentry image

Hands-on debugging session: instrument, monitor, and fix

Join Lazar for a hands-on session where you’ll build it, break it, debug it, and fix it. You’ll set up Sentry, track errors, use Session Replay and Tracing, and leverage some good ol’ AI to find and fix issues fast.

RSVP here →

Top comments (0)

Billboard image

The Next Generation Developer Platform

Coherence is the first Platform-as-a-Service you can control. Unlike "black-box" platforms that are opinionated about the infra you can deploy, Coherence is powered by CNC, the open-source IaC framework, which offers limitless customization.

Learn more

👋 Kindness is contagious

Please leave a ❤️ or a friendly comment on this post if you found it helpful!

Okay