⚡️ WYX CLI ⚡️

Optimize your development productivity in the terminal

⚡️ WYX CLI ⚡️

What It Does

Provides developers with the ability for optimising the execution of commonly performed tasks, commands, directory navigations, and environment setups/script executions.

Why It Was Made

I found myself executing the same commands repeatedly, finding navigation on the terminal for frequently accessed locations needlessly slow, and the task of pushing out new code via manually submitting a PR on my browser repetitive and time-wasting. I decided to start developing my own bash scripting library to help alleviate these issues, and realized the whole world of opportunity I had to help optimize my own daily workflows on the terminal. Due to my experience working simultaneously on Mac and Linux machines one of the key parts of the WYX-CLI project was to also allow the same code to run in different shells and operating systems.

Support This Project

If you have found this tool useful/insightful please leave a ⭐ on the repository it really helps me out!

I also have a buymeacoffee sponsor link if you would like to help turn my caffeine addiction into a problem ☕⚡

Installation

Clone this repository into a folder of your choice:

git clone [email protected]:hwixley/WYX-CLI.git

Navigate into the directory:

cd WYX-CLI

Give permissions to the setup script and run it:

chmod +x setup.sh && ./setup.sh

Reopen your terminal or run source ~/.bashrc (source ~/.zshrc for unix systems)

Type wyx to see the list of commands and start developing some magic!

Extra Feature Setup

You can use OpenAI's ChatGPT to write commit messages for you (using git diff and git status outputs) when using the wyx push command. This requires an OpenAI API key.

wyx setup smart_commit

Factory-reset Installation

Remove your cloned repository

rm -rf <path-of-installation>

Remove the wyx-cli script setup in your environment file
- Open the file in an editor: (~/.bashrc for linux systems, and ~/.zshrc for unix systems)
```
gedit ~/.bashrc
```
  If gedit is not available you can always use vim instead:
```
vi ~/.bashrc
```
- Remove the 2 lines for the wyx-cli:
  - The first line is a comment: # WYX-CLI
  - The second line is where the command is actually setup: alias wyx="<path-of-installation>/wyx-cli.sh"
Follow the installation instructions

Dependencies

View current dependencies for your system by running:

wyx list-deps

List of Commands

VERSION 📦

version: WYX-CLI Version

DEPENDENCIES 📦

install-deps: Install WYX-CLI dependencies
update-deps: Update the project dependencies
list-deps: List the project dependencies

SYSTEM 🖥️

sys-info: Get Detailed System Information

DIRECTORY NAVIGATION 📍

cd <mydir?>: Navigate Directory Aliases
back: Go Back A Directory

CODE 💲

run <myscript>: Run Script Aliases
vsc <mydir>: Open Directory Aliases in VSCode

GIT AUTOMATION 🐙

ginit: Initialise Git Repository
push: Add-Commit-Push Git Changes to Current Branch
pull: Pull Git Changes for Current Branch
mpull: Checkout-Pull Git Changes From Master/Main Branch
commits: View Your Branch Git Commits
lastcommit: View Your Last Commit & Copy It's SHA
nb <branch-name?>: Checkout-Add-Commit-Push A New Git Branch
pr: Open A Pull Request From Your Current Git Branch on GitHub/GitLab/BitBucket/Azure
bpr <branch-name?>: Checkout-Add-Commit-Push New Git Branch & Open PR On GitHub/GitLab/BitBucket/Azure
pp: Pull-Push Git Changes to Current Branch

URLs 🔗

repo: View Your Repository On GitHub/GitLab/BitBucket/Azure
branch: View Your Current Branch On GitHub/GitLab/BitBucket/Azure
pipelines: View Your Pipelines On GitHub/GitLab/BitBucket/Azure
issues: View Your Repository Issues On GitHub/GitLab/BitBucket/Azure
prs: View Your Repository PRs On GitHub/GitLab/BitBucket/Azure
notifs: View Your GitHub Notifications
profile: View Your GitHub Profile
org <myorg?>: View Your GitHub Organisation

ENV/KEYSTORE 🗝️

keystore <key?> <value?>: Add a key-value pair to your '.env' keystore
setup <smart_commit|openai_key|auto_update>: "Setup: ChatGPT commits, ChatGPT client, WYX-CLI auto-updates"

MY DATA 📂

user: View Your User Configuration
mydirs: View Your Directory Aliases Configuration
myorgs: View Your GitHub Organisation Configuration
myscripts: View Your Scripts Configuration
todo: View Your To-Do List

MANAGE MY DATA 📂

editd <user|myorgs|mydirs|myscripts|todo>: Edit Your WYX-CLI Configuration
edits <myscript?>: Edit A Script File
newscript <name?>: Create A New Script

FILE UTILITIES 📁

find <regex?>: Regex Search Current Directory For File
fopen <dir|mydir?>: Open current directory in your files application
encrypt <file|dir?>: Encrypt a file using GPG
decrypt <file?>: Decrypt a GPG-encrypted file

NETWORK UTILITIES 📡

ip: View Your Local & Public IPs
wifi: View Available WiFi Networks
hardware-ports: View Your Hardware Ports
wpass: View Your Saved WiFi Passwords
speedtest: Run A Speed Test On Your Network
port-scan <host?> <port-range?>: Scan for open ports on a host

WEB UTILITIES 🌐

webtext <url?>: Read-only websites in your terminal

AI UTILITIES 🤖

ask-gpt: Start a conversation with ChatGPT

TEXT UTILITIES 📝

genpass <pass-length?>: Generate A Random Password
genhex <length?>: Generate A Random Hex String
genb64 <length?>: Generate A Random Base64 String
lastcmd: Copy Your Last Command To Your Clipboard
copy $(<command?>): Copy output of a command to clipboard

IMAGE UTILITIES 📸

genqr <url?> <name?>: Generate a QR code from a URL
upscale <file?> <scale-multiplier?>: Scale up an image (uses no smoothing)

MISC UTILITIES 🛠️

weather: View the weather forecast for your location in the terminal
moon: View the moon phase
leap-year: Check when the next leap year is

HELP UTILITIES ℹ️

help: View WYX-CLI Documentation
explain <command?>: Explain a bash command
google <query?>: Google a query

hwixley / wyx-cli Goto Github PK

wyx-cli's Introduction