https://github.com/ytbryan/cli

https://github.com/ytbryan/cli

Last synced: about 4 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/ytbryan/cli
• Owner: ytbryan
• Created: 2024-07-06T02:56:38.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-04T15:32:13.000Z (4 months ago)
• Last Synced: 2024-08-04T16:08:27.694Z (4 months ago)
• Language: Shell
• Size: 10.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# CLI

Are you tired of running the virtual environment setup script? 

Or the git module commands to pull all modules? Or perhaps you have more multi-steps command that you have already written and lazy to type the full path?  

# Meet CLI

`cli` is a simple everyday cli with a simple mission. Save you keystroke and increase your project efficiency (& accuracy). Look at these benefits:

1. 📐Shorter. Better. Run shorter commands `setup`, `pull`, `module` with standardisation

2. 👯‍♂️ Same same! Stop saving script into dev/ or use different standardisation

3. ❌ No 3rd party script needed. Just use back the good default: `pip` and `python`

4. 🔋🔋🔋 Extra batteries will be included. Add on more scripts as you build along. Use an easy config file. 

# Installation

1. This method works. 

```

git clone https://github.com/ytbryan/cli

#then add the export CLI_PATH of cli path.

```

2. Add the repo to the PATH

> create a cli folder and the folder will be filled with config.yml and scripts

```bash

export CLI_PATH="$PATH:/cli"

```

Alternatively

```

pip install git+http://github.com/ytbryan/cli.git

```

# Getting started

`setup` does two things. It will insert the `CLI_PATH` as a location to .config.yml and the scripts if `CLI_PATH` is empty. 

And further add cli into PATH such that cli can be used globally across projects.  

```

cli setup 

```

## Set the CLI_PATH

```bash

export CLI_PATH=""

```

## cli --help

```

cli --help

```

## TODO

- [x] ship it

- [x] add config.yml

- [x] add `age` to show git commits and its age

- [ ] add `show` to show the content of the file

- [x] add alias to each command

- [ ] integrate with pyenv and pick up python version

- [ ] Add Procfile + Honcho

- [ ] 

## LICENSE

MIT