https://github.com/yaxingson/pretty-shell
Utilities for using unix shell commands from node.js
https://github.com/yaxingson/pretty-shell
commands node shell terminal
Last synced: 4 months ago
JSON representation
Utilities for using unix shell commands from node.js
- Host: GitHub
- URL: https://github.com/yaxingson/pretty-shell
- Owner: yaxingson
- License: mit
- Created: 2024-05-24T06:25:38.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-15T12:42:05.000Z (10 months ago)
- Last Synced: 2025-10-01T17:55:03.974Z (9 months ago)
- Topics: commands, node, shell, terminal
- Language: TypeScript
- Homepage:
- Size: 176 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Quick start
### Install
```shell
# via npm
$ npm i pretty-shell --save
$ npm i pretty-shell -g
```
### Usage
Command line：
```shell
$ shx mkdir -p foo
$ shx touch foo/bar.txt
$ shx rm -rf foo
```
Node API:
```js
const shell = require('pretty-shell')
const { mkkdir, touch , rm } = require('pretty-shell')
```
### Configuration
## Commands
| category | command | description |
| ----- | ------ | ----- |
| fs | cd | Change the shell working directory. |
| | ls | List information about the FILEs (the current directory by default). |
| | cat | Concatenate FILE(s) to standard output. |
| | cp | Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY. |
| | find | Search for files in a directory hierarchy. |
| | pwd | Print the name of the current working directory. |
| | mkdir | Create the DIRECTORY(ies), if they do not already exist. |
| | rm | Remove (unlink) the FILE(s). |
| | rmdir | Remove the DIRECTORY(ies), if they are empty. |
| | mv | Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY. |
| | grep | PATTERNS can contain multiple patterns separated by newlines. |
| | chmod | Change the mode of each FILE to MODE. |
| | chown | Change the owner and/or group of each FILE to OWNER and/or GROUP. |
| | touch | Update the access and modification times of each FILE to the current time. |
| | whereis | Locate the binary, source, and manual-page files for a command. |
| | find | Search for files in a directory hierarchy. |
| | zip | Package and compress (archive) files. |
| | unzip | List, test and extract compressed files in a ZIP archive. |
| | gzip | Compress or uncompress FILEs (by default, compress FILES in-place). |
| | tar | An archiving utility. |
| | tail | Print the last 10 lines of each FILE to standard output. |
| | ln | Make links between files. |
| | stat | Display file or file system status. |
| | egrep | PATTERNS can contain multiple patterns separated by newlines. |
| | more | A file perusal filter for CRT viewing. |
| | less | |
| | head | Print the first 10 lines of each FILE to standard output. |
| | tail | Print the last 10 lines of each FILE to standard output. |
| | tac | Write each FILE to standard output, last line first. |
| | nl | Write each FILE to standard output, with line numbers added. |
| | wc | Print newline, word, and byte counts for each FILE, and a total line if more than one FILE is specified. |
| | split | Output pieces of FILE to PREFIXaa, PREFIXab, ... |
| | cut | Print selected parts of lines from each FILE to standard output. |
| | paste | Write lines consisting of the sequentially corresponding lines from each FILE, separated by TABs, to standard output. |
| | sort | Write sorted concatenation of all FILE(s) to standard output. |
| | uniq | Filter adjacent matching lines from INPUT (or standard input), writing to OUTPUT (or standard output). |
| | diff | Compare FILES line by line. |
| | patch | Apply a diff file to an original. |
| | join | For each pair of input lines with identical join fields, write a line to standard output. |
| | tr | Translate, squeeze, and/or delete characters from standard input, writing to standard output. |
| | sed | Stream editor for filtering and transforming text. |
| | awk | Pattern scanning and processing language. |
| | du | Summarize disk usage of the set of FILEs, recursively for directories. |
| | df | Show information about the file system on which each FILE resides, or all file systems by default. |
| | sync | Synchronize cached writes to persistent storage. |
| | mount | Mount a filesystem. |
| | dd | Copy a file, converting and formatting according to the operands. |
| | zip | Package and compress (archive) files. |
| | zcat | Uncompress FILEs to standard output. |
| | xz | Compress or decompress FILEs in the .xz format. |
| | bzip2 | A block-sorting file compressor. |
| | free | Display amount of free and used memory in the system. |
| net | ifconfig | Configure a network interface. |
| | netstat | Print network connections, routing tables, interface statistics, masquerade connections, and multicast memberships. |
| | ping | Send ICMP ECHO_REQUEST to network hosts. |
| | traceroute | Print the route packets trace to network host. |
| | ss | Another utility to investigate sockets. |
| | telnet | User interface to the TELNET protocol. |
| | ssh | OpenSSH remote login client. |
| | ftp | Internet file transfer program. |
| | ip | show / manipulate routing, network devices, interfaces and tunnels. |
| | sftp | OpenSSH secure file transfer. |
| | lftp | Sophisticated file transfer program. |
| | wget | The non-interactive network downloader. |
| | scp | OpenSSH secure file copy. |
| | curl | Transfer a URL. |
| | host | DNS lookup utility. |
| os | date ||
| | free ||
| | uname ||
| | nohup ||
| | df | Show information about the file system on which each FILE resides, or all file systems by default. |
| | top | Display Linux processes. |
| | free | Display amount of free and used memory in the system. |
| | history | Display or manipulate the history list. |
| | ps | report a snapshot of the current processes. |
| | pstree | Display a tree of processes. |
| | systemctl | Query or send control commands to the system manager. |
| | help | Display information about builtin commands. |
| | w | Show who is logged on and what they are doing. |
| | whoami | Print the user name associated with the current effective user ID. |
| | last | Show a listing of last logged in users. |
| | kill | Send a signal to a process. |
| | firewall-cmd | |
| | uptime | Tell how long the system has been running. |
| | ulimit | Modify shell resource limits. |
| | service | Run a System V init script. |
| | ipcs | Show information on IPC facilities. |
| | ipcrm | Remove certain IPC resources. |
| | bc | An arbitrary precision calculator language. |
| | watch | Execute a program periodically, showing output fullscreen. |
| | time | Run programs and summarize system resource usage. |
| | reboot | Reboot the system. |
| | init | Send control commands to the init daemon. |
| | date | Display the current time in the given FORMAT, or set the system date. |
| | cal | Displays a calendar and the date of Easter. |
| | htop | Interactive process viewer. |
| | lscpu | Display information about the CPU architecture. |
| | rsync | A fast, versatile, remote (and local) file-copying tool. |
| | ssh-keygen | OpenSSH authentication key utility. |
| | shutdown | Shut down the system. |
| | lsof | List open files. |
| | jobs | |
| | nohup | Run COMMAND, ignoring hangup signals. |
| | env | Set each NAME to VALUE in the environment and run COMMAND. |
| | xargs | Run COMMAND with arguments INITIAL-ARGS and more arguments read from input. |
| | exec | |
| | crontab | Maintain crontab files for individual users (Vixie Cron). |
## Examples
```js
const { find } = require('pretty-shell')
```