Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[feature]: enhanced command info categories and script descriptions UX #57

Merged
merged 5 commits into from
May 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified .generated/wyxcli-output-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 28 additions & 26 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,26 +112,26 @@ wyx list-deps

## List of Commands

### VERSION:
### VERSION 📦
- `version`: WYX-CLI Version

### SYSTEM:
- `sys-info`: Get Detailed System Information

### DEPENDENCIES:
### DEPENDENCIES 📦
- `install-deps`: Install WYX-CLI dependencies
- `update-deps`: Update the project dependencies
- `list-deps`: List the project dependencies

### DIRECTORY NAVIGATION:
### SYSTEM 🖥️
- `sys-info`: Get Detailed System Information

### DIRECTORY NAVIGATION 📍
- `cd <mydir?>`: Navigate Directory Aliases
- `back`: Go Back A Directory

### CODE:
### CODE 💲
- `run <myscript>`: Run Script Aliases
- `vsc <mydir>`: Open Directory Aliases in VSCode

### GIT AUTOMATION:
### GIT AUTOMATION 🐙
- `ginit`: Initialise Git Repository
- `push`: Add-Commit-Push Git Changes to Current Branch
- `pull`: Pull Git Changes for Current Branch
Expand All @@ -143,7 +143,7 @@ wyx list-deps
- `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:
### 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
Expand All @@ -153,56 +153,58 @@ wyx list-deps
- `profile`: View Your GitHub Profile
- `org <myorg?>`: View Your GitHub Organisation

### MY DATA:
### 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:
### 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

### ENV/KEYSTORE:
- `keystore <key?> <value?>`: Add a key-value pair to your '.env' keystore
- `setup <smart_commit>`: Setup WYX-CLI Third Party API-based utilities

### FILE UTILITIES:
### 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:
### 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

### IMAGE UTILITIES:
- `genqr <url?> <name?>`: Generate a QR code from a URL
- `upscale <file?> <scale-multiplier?>`: Scale up an image (uses no smoothing)
### WEB UTILITIES 🌐
- `webtext <url?>`: Read-only websites in your terminal

### AI UTILITIES 🤖
- `ask-gpt`: Start a conversation with ChatGPT

### TEXT UTILITIES:
### 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

### WEB UTILITIES:
- `webtext <url?>`: Read-only websites in your terminal
### 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:
### 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 UTILITIES ℹ️
- `help`: View WYX-CLI Documentation
- `explain <command?>`: Explain a bash command
- `ask-gpt`: Start a conversation with ChatGPT
- `google <query?>`: Google a query
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Pull Request Checks
- [ ] An appropriate title prefix (`[BUG-FIX]`, `[NEW-FEATURE]`,`[REFINEMENT]`, `[METADATA]`) and title have been used.
- [ ] An appropriate title prefix (`[bugfix]`, `[feature]`,`[refactor]`, `[chore]`) and title have been used.
- [ ] Documentation has been updated on the README and `wyx` command output where necessary.

# What changes have been made
Expand Down
4 changes: 2 additions & 2 deletions src/classes/lib/lib.class
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ lib.csv.all(){
fi
cat=$(lib.csv.query.one 'arg_categories' 'name' "where id='$category'")
if [ "$type" = "git" ]; then
echo "### ${cat}:"
echo "### ${cat}"
else
sys.log.h1 "${cat}:"
sys.log.h1 "${cat}"
fi
for script in "${scripts[@]:1}"; do
if [ "$script" = "" ]; then
Expand Down
6 changes: 6 additions & 0 deletions src/commands/setup.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ elif [ "$1" = "smart_commit" ]; then
wyxd.check_keystore "OPENAI_API_KEY"
wyxd.check_keystore "USE_SMART_COMMIT" "true"
sys.log.info "You're done!"

elif [ "$1" = "auto_update" ]; then
sys.log.info "Setting up auto update..."
echo ""
wyxd.check_keystore "AUTO_UPDATE" "true"
sys.log.info "You're done!"

else
sys.log.error "Invalid setup command! Try again"
Expand Down
54 changes: 28 additions & 26 deletions src/data/.cache/cmdinfo.git.wyx
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
### VERSION:
### VERSION 📦
- `version`: WYX-CLI Version

### SYSTEM:
- `sys-info`: Get Detailed System Information

### DEPENDENCIES:
### DEPENDENCIES 📦
- `install-deps`: Install WYX-CLI dependencies
- `update-deps`: Update the project dependencies
- `list-deps`: List the project dependencies

### DIRECTORY NAVIGATION:
### SYSTEM 🖥️
- `sys-info`: Get Detailed System Information

### DIRECTORY NAVIGATION 📍
- `cd <mydir?>`: Navigate Directory Aliases
- `back`: Go Back A Directory

### CODE:
### CODE 💲
- `run <myscript>`: Run Script Aliases
- `vsc <mydir>`: Open Directory Aliases in VSCode

### GIT AUTOMATION:
### GIT AUTOMATION 🐙
- `ginit`: Initialise Git Repository
- `push`: Add-Commit-Push Git Changes to Current Branch
- `pull`: Pull Git Changes for Current Branch
Expand All @@ -29,7 +29,7 @@
- `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:
### 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
Expand All @@ -39,57 +39,59 @@
- `profile`: View Your GitHub Profile
- `org <myorg?>`: View Your GitHub Organisation

### MY DATA:
### 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:
### 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

### ENV/KEYSTORE:
- `keystore <key?> <value?>`: Add a key-value pair to your '.env' keystore
- `setup <smart_commit>`: Setup WYX-CLI Third Party API-based utilities

### FILE UTILITIES:
### 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:
### 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

### IMAGE UTILITIES:
- `genqr <url?> <name?>`: Generate a QR code from a URL
- `upscale <file?> <scale-multiplier?>`: Scale up an image (uses no smoothing)
### WEB UTILITIES 🌐
- `webtext <url?>`: Read-only websites in your terminal

### AI UTILITIES 🤖
- `ask-gpt`: Start a conversation with ChatGPT

### TEXT UTILITIES:
### 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

### WEB UTILITIES:
- `webtext <url?>`: Read-only websites in your terminal
### 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:
### 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 UTILITIES ℹ️
- `help`: View WYX-CLI Documentation
- `explain <command?>`: Explain a bash command
- `ask-gpt`: Start a conversation with ChatGPT
- `google <query?>`: Google a query

54 changes: 28 additions & 26 deletions src/data/.cache/cmdinfo.term.wyx
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
VERSION:
VERSION 📦
- version: WYX-CLI Version

SYSTEM:
- sys-info: Get Detailed System Information

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

DIRECTORY NAVIGATION:
SYSTEM 🖥️
- sys-info: Get Detailed System Information

DIRECTORY NAVIGATION 📍
- cd <mydir?>: Navigate Directory Aliases
- back: Go Back A Directory

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

GIT AUTOMATION:
GIT AUTOMATION 🐙
- ginit: Initialise Git Repository
- push: Add-Commit-Push Git Changes to Current Branch
- pull: Pull Git Changes for Current Branch
Expand All @@ -29,7 +29,7 @@
- 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:
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
Expand All @@ -39,57 +39,59 @@
- profile: View Your GitHub Profile
- org <myorg?>: View Your GitHub Organisation

MY DATA:
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:
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

ENV/KEYSTORE:
- keystore <key?> <value?>: Add a key-value pair to your '.env' keystore
- setup <smart_commit>: Setup WYX-CLI Third Party API-based utilities

FILE UTILITIES:
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:
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

IMAGE UTILITIES:
- genqr <url?> <name?>: Generate a QR code from a URL
- upscale <file?> <scale-multiplier?>: Scale up an image (uses no smoothing)
WEB UTILITIES 🌐
- webtext <url?>: Read-only websites in your terminal

AI UTILITIES 🤖
- ask-gpt: Start a conversation with ChatGPT

TEXT UTILITIES:
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

WEB UTILITIES:
- webtext <url?>: Read-only websites in your terminal
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:
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 UTILITIES ℹ️
- help: View WYX-CLI Documentation
- explain <command?>: Explain a bash command
- ask-gpt: Start a conversation with ChatGPT
- google <query?>: Google a query

Loading