https://github.com/kyle-west/bashful

🖥 Install my custom suite of terminal tools for Bash in Mac OS X
https://github.com/kyle-west/bashful

Last synced: 3 months ago
JSON representation

🖥 Install my custom suite of terminal tools for Bash in Mac OS X

• Host: GitHub
• URL: https://github.com/kyle-west/bashful
• Owner: kyle-west
• License: mit
• Created: 2018-11-15T19:57:07.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-08-06T16:27:41.000Z (almost 5 years ago)
• Last Synced: 2025-01-10T04:25:27.099Z (5 months ago)
• Language: Shell
• Homepage: https://kyle-west.github.io/bashful
• Size: 115 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Bashful Suite by kyle-west](./docs/logo.png)

---

![Primary Support for Mac OS X](https://img.shields.io/badge/platform-osx-%23)

[![Install Version](https://img.shields.io/github/v/tag/kyle-west/bashful?label=version)](https://github.com/kyle-west/bashful/releases/latest)

[![Actions Status](https://github.com/kyle-west/bashful/workflows/CI%20Test/badge.svg)](https://github.com/kyle-west/bashful/actions)

`BASHful` is a set of tools I regularly use in my personal development workflow.

This package allows me to share my tools with others. I am always up for ideas 

on how to improve my toolset, so feel free to pitch ideas or enhancements on the 

[Issue Page](https://github.com/kyle-west/bashful/issues). 

# Tools in the Suite and their Documentation

A list of available tools and their usages can be found on the [Documentation Page](https://kyle-west.github.io/bashful/).

# Installing 

Though most of the code is not written in JavaScript, some of the tools in bashful require `node` (version 8 or higher). You must first [install `NodeJS`](https://nodejs.org/en/download/) on your machine.

Then you may run the following command to install bashful:

```sh

npx -q https://github.com/kyle-west/bashful.git

```

When the script completes, **you must restart your terminal**. This 

is because the installation edits your `$path` environment variable to make the 

tools accessible in all contexts. 

### Installing / Uninstalling Tools

`bashful` CLI has it's own installation management of tools, including gists. See the [Docs](https://kyle-west.github.io/bashful/bashful.html) for more info.

### Uninstalling the entire Suite

The uninstall is easy, and, like the install, requires a restart afterwards.

```sh

bashful uninstall --remove-suite

```

If you wish to uninstall a specific tool, see the [Docs](https://kyle-west.github.io/bashful/bashful.html) for more info.

### Updating 

The `bashful` tool has built in support for updating programs (including installed `gists`)

```sh

bashful update [program]

```