ClearShell

Readable commands for ZSH, with a sense of humor.

ClearShell turns everyday terminal work into strict, human-readable proclamations:

proclaim <action>!

Every command must begin with proclaim, end with !, perform a readable action, and finish with:

ClearShell V0.1.0 Public Alpha

Install

Install the package from npm:

npm install -g clearshell

Add the plugin to your ZSH configuration:

source "$(npm root -g)/clearshell/clearshell.zsh"

For a local project install, use the package path instead:

source "./node_modules/clearshell/clearshell.zsh"

Reload ZSH:

source ~/.zshrc

Quick Start

proclaim clearshell-help!
proclaim where-am-i!
proclaim show-files!
proclaim go-to Projects!
proclaim file-read notes.txt!
proclaim soil-pants!

Commands

Navigation

go-up, go-home, go-to <directory>, uncd, where-am-i

Files and folders

show-files, show-hidden, make-file <path>, make-folder <path>, file-read <path>, file-info <path>, file-size <path>, line-count <path>, file-preview <path>, file-tail <path>, file-type <path>, checksum <path>, file-copy <from> <to>, file-move <from> <to>, symlink-create <from> <to>, file-search <name>, find-text <phrase> [path], count-files, disk-usage [path]

Archives and desktop tools

archive-create <archive> <path>, archive-extract <archive> [directory], open-file <path>, reveal-file <path>, clipboard-copy <text>, clipboard-paste, download-file <url> <path>, uuid

Git

git-status, git-diff, git-branches, git-commit <message>, git-push, git-pull, git-history

System

system-info, system-space, system-processes, system-memory, process-find <name>, process-kill <pid>, port-check <port>, check-command <name>, env-list, path-list, current-time, calendar, terminal-size, reload-shell

Nonsense emergencies

random-number, flip-coin, roll-dice, tell-joke, soil-pants

Safety

Destructive actions require exact confirmation:

yea sure

Type this to cancel:

no don't

Missing files, directories, paths, branches, and other nonexistent things produce:

Computer tyrant, that doesn't exist!

Configuration

Configuration uses the same syntax:

proclaim clearshell-config set prompt minimal!
proclaim clearshell-config set safeguards strong!
proclaim clearshell-config set humor spicy!

Development

Clone the repository, then run:

npm test
npm run pack:check

The package contains the ZSH plugin, documentation, license, and focused tests. It does not require a Node.js runtime when used from ZSH.

License

MIT