Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jacobsteves/yeah
A personal CLI to improve development flow
https://github.com/jacobsteves/yeah
Last synced: about 1 month ago
JSON representation
A personal CLI to improve development flow
- Host: GitHub
- URL: https://github.com/jacobsteves/yeah
- Owner: jacobsteves
- License: mit
- Created: 2020-03-02T22:56:03.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-30T20:34:17.000Z (over 3 years ago)
- Last Synced: 2023-11-08T19:49:43.545Z (about 1 year ago)
- Language: Ruby
- Homepage:
- Size: 122 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## About
Yeah is a CLI designed to improve the workflow of a shell. Pull requests + more commands are welcome!
The following commands are currently supported:
- [Goto](https://github.com/jacobsteves/yeah#goto): Save keywords as directory shortcuts and change to thier directory
- [Custom Commands](https://github.com/jacobsteves/yeah#custom-commands): Execute custom commands written within a `yeah.yml` file
## Installation
1. Clone the repo
2. We have to source our [yeah.sh](yeah.sh) file. So, in your shell config (ie, `.bash_profile`, `.bashrc`, `.zshrc`, etc) set:
```bash
if [[ -f /your/path/to/yeah/yeah.sh ]]
then
source /your/path/to/yeah/yeah.sh
fi
```
3. Reload your shell
## Commands
### Help
Easily get help for any available Yeah command.
- Usage: `yeah help some_command`
- Note that if there is a project context (ie, a `yeah.yml` file), then
you will be able to use this help for the specified custom commands as well.
### Goto
Change directories to a location indicated by a keyword.
- Usage: `yeah goto some_keyword [--set=] [--delete] [--clear] [--list]`
- Example:
```
# Set new keyword: test
yeah goto test --set=/my/path
# Go to keyword: test => cd /my/path
yeah goto test
# Delete keyword: test
yeah goto test --delete
# List all keywords
yeah goto --list
# Delete all keywords
yeah goto --clear
```
### Custom Commands
This is designed so that you can save different commands and execute them easily.
You can create a `yeah.yml` file and configure it. Under the `commands` scope, you can declare commands.
These commands can be run the same way as a regular command. For example, a command named `custom_test` can
be run by invoking `yeah custom_test`.
- Usage: `yeah some_custom_command [--args] [--to_be_forwarded] [--to_specified_command]`
- Example:
```yaml
# yeah.yml
commands:
install:
desc: install dependencies via npm
run: npm install
```
```
$ yeah install # runs: npm install
npm output...
$ yeah install --silent # runs: npm install --silent
```
#### Example Configuration
```yaml
# yeah.yml
name: yeah
commands:
# yeah test
test:
run: rake test
# yeah hello
hello:
desc: prints Hello World!
run: echo "Hello world!"
# yeah readme
readme:
desc: An example command printing the readme.
run:
- echo 'Hello there!'
- cat README.md
# yeah rubocop
rubocop:
desc: Runs the rubocop linter
run: rubocop
# yeah calls_another_command
calls_another_command:
desc: This command calls the hello command specific above
run: hello
# yeah invalid
invalid:
desc: Since this command has no run key, it should fail on execution
# yeah another_invalid
another_invalid:
desc: Cannot have nested actions.
run:
test: echo 'This is not allowed'
```
## Libraries
Yeah uses [CLI-UI](https://github.com/shopify/cli-ui) and [CLI-Kit](https://github.com/shopify/cli-kit) as the CLI
framework.