Merge pull request #54 from hwixley/arg-support

Arg support
hwixley · Mar 16, 2024 · 0b5c00e · 0b5c00e
2 parents f743e5c + fe40146
commit 0b5c00e
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 49 deletions.
diff --git a/.github/README.md b/.github/README.md
@@ -124,12 +124,12 @@ wyx list-deps
 - `list-deps`: List the project dependencies
 
 ### DIRECTORY NAVIGATION:
-- `cd`: Navigate Directory Aliases
+- `cd <mydir?>`: Navigate Directory Aliases
 - `back`: Go Back A Directory
 
 ### CODE:
-- `run`: Run Script Aliases
-- `vsc`: Open Directory Aliases in VSCode
+- `run <myscript>`: Run Script Aliases
+- `vsc <mydir>`: Open Directory Aliases in VSCode
 
 ### GIT AUTOMATION:
 - `ginit`: Initialise Git Repository
@@ -138,9 +138,9 @@ wyx list-deps
 - `mpull`: Checkout-Pull Git Changes From Master/Main Branch
 - `commits`: View Your Branch Git Commits
 - `lastcommit`: View Your Last Commit & Copy It's ID
-- `nb`: Checkout-Add-Commit-Push A New Git Branch
+- `nb <branch-name?>`: Checkout-Add-Commit-Push A New Git Branch
 - `pr`: Open A Pull Request From Your Current Git Branch on GitHub
-- `bpr`: Checkout-Add-Commit-Push A New Git Branch & Open A PR For It On GitHub
+- `bpr <branch-name?>`: Checkout-Add-Commit-Push A New Git Branch & Open A PR For It On GitHub
 - `pp`: Pull-Push Git Changes to Current Branch
 
 ### URLs:
@@ -151,7 +151,7 @@ wyx list-deps
 - `prs`: View Your Repository PRs On GitHub
 - `notifs`: View Your GitHub Notifications
 - `profile`: View Your GitHub Profile
-- `org`: View Your GitHub Organisation
+- `org <myorg?>`: View Your GitHub Organisation
 
 ### MY DATA:
 - `user`: View Your User Configuration
@@ -167,7 +167,7 @@ wyx list-deps
 
 ### ENV/KEYSTORE:
 - `keystore`: Add a key-value pair to your '.env' keystore
-- `setup`: Setup WYX-CLI Third Party API-based utilities
+- `setup <smart_commit>`: Setup WYX-CLI Third Party API-based utilities
 
 ### FILE UTILITIES:
 - `find`: Regex Search Current Directory For File
@@ -187,14 +187,14 @@ wyx list-deps
 - `upscale`: Scale up an image (uses no smoothing)
 
 ### TEXT UTILITIES:
-- `genpass`: Generate A Random Password
+- `genpass <pass-length?>`: Generate A Random Password
 - `genhex`: Generate A Random Hex String
 - `genb64`: Generate A Random Base64 String
 - `lastcmd`: Copy Your Last Command To Your Clipboard
-- `copy`: Copy output of a command to clipboard
+- `copy <command?>`: Copy output of a command to clipboard
 
 ### WEB UTILITIES:
-- `webtext`: Read-only websites in your terminal
+- `webtext <url?>`: Read-only websites in your terminal
 
 ### MISC UTILITIES:
 - `weather`: View the weather forecast for your location in the terminal
@@ -203,6 +203,6 @@ wyx list-deps
 
 ### HELP UTILITIES:
 - `help`: View WYX-CLI Documentation
-- `explain`: Explain a bash command
+- `explain $(<command?>)`: Explain a bash command
 - `ask-gpt`: Start a conversation with ChatGPT
-- `google`: Google a query
+- `google <query?>`: Google a query
diff --git a/src/classes/lib/lib.class b/src/classes/lib/lib.class
@@ -46,10 +46,15 @@ lib.csv.all(){
                 continue
             fi
             name=$(lib.csv.query.one 'arg_scripts' 'name' "where id='$script'")
+            arg=$(lib.csv.query.one 'arg_scripts' 'args' "where id='$script'" | tr -d '"')
+            command_name="$script"
+            if [[ "$arg" != "" ]] || [[ "$arg" = "\"\"" ]]; then
+                command_name="$script $arg"
+            fi
             if [ "$type" = "git" ]; then
-                echo "- \`$script\`: ${ORANGE}${name}${RESET}"
+                echo "- \`$command_name\`: ${ORANGE}${name}${RESET}"
             else
-                echo "- $script: ${ORANGE}${name}${RESET}"
+                echo "- $command_name: ${ORANGE}${name}${RESET}"
             fi
         done
         echo ""

diff --git a/src/data/.cache/cmdinfo.git.wyx b/src/data/.cache/cmdinfo.git.wyx
@@ -10,12 +10,12 @@
 - `list-deps`: [33mList the project dependencies[37m
 
 ### DIRECTORY NAVIGATION:
-- `cd`: [33mNavigate Directory Aliases[37m
+- `cd <mydir?>`: [33mNavigate Directory Aliases[37m
 - `back`: [33mGo Back A Directory[37m
 
 ### CODE:
-- `run`: [33mRun Script Aliases[37m
-- `vsc`: [33mOpen Directory Aliases in VSCode[37m
+- `run <myscript>`: [33mRun Script Aliases[37m
+- `vsc <mydir>`: [33mOpen Directory Aliases in VSCode[37m
 
 ### GIT AUTOMATION:
 - `ginit`: [33mInitialise Git Repository[37m
@@ -24,9 +24,9 @@
 - `mpull`: [33mCheckout-Pull Git Changes From Master/Main Branch[37m
 - `commits`: [33mView Your Branch Git Commits[37m
 - `lastcommit`: [33mView Your Last Commit & Copy It's ID[37m
-- `nb`: [33mCheckout-Add-Commit-Push A New Git Branch[37m
+- `nb <branch-name?>`: [33mCheckout-Add-Commit-Push A New Git Branch[37m
 - `pr`: [33mOpen A Pull Request From Your Current Git Branch on GitHub[37m
-- `bpr`: [33mCheckout-Add-Commit-Push A New Git Branch & Open A PR For It On GitHub[37m
+- `bpr <branch-name?>`: [33mCheckout-Add-Commit-Push A New Git Branch & Open A PR For It On GitHub[37m
 - `pp`: [33mPull-Push Git Changes to Current Branch[37m
 
 ### URLs:
@@ -37,7 +37,7 @@
 - `prs`: [33mView Your Repository PRs On GitHub[37m
 - `notifs`: [33mView Your GitHub Notifications[37m
 - `profile`: [33mView Your GitHub Profile[37m
-- `org`: [33mView Your GitHub Organisation[37m
+- `org <myorg?>`: [33mView Your GitHub Organisation[37m
 
 ### MY DATA:
 - `user`: [33mView Your User Configuration[37m
@@ -53,7 +53,7 @@
 
 ### ENV/KEYSTORE:
 - `keystore`: [33mAdd a key-value pair to your '.env' keystore[37m
-- `setup`: [33mSetup WYX-CLI Third Party API-based utilities[37m
+- `setup <smart_commit>`: [33mSetup WYX-CLI Third Party API-based utilities[37m
 
 ### FILE UTILITIES:
 - `find`: [33mRegex Search Current Directory For File[37m
@@ -73,14 +73,14 @@
 - `upscale`: [33mScale up an image (uses no smoothing)[37m
 
 ### TEXT UTILITIES:
-- `genpass`: [33mGenerate A Random Password[37m
+- `genpass <pass-length?>`: [33mGenerate A Random Password[37m
 - `genhex`: [33mGenerate A Random Hex String[37m
 - `genb64`: [33mGenerate A Random Base64 String[37m
 - `lastcmd`: [33mCopy Your Last Command To Your Clipboard[37m
-- `copy`: [33mCopy output of a command to clipboard[37m
+- `copy <command?>`: [33mCopy output of a command to clipboard[37m
 
 ### WEB UTILITIES:
-- `webtext`: [33mRead-only websites in your terminal[37m
+- `webtext <url?>`: [33mRead-only websites in your terminal[37m
 
 ### MISC UTILITIES:
 - `weather`: [33mView the weather forecast for your location in the terminal[37m
@@ -89,7 +89,7 @@
 
 ### HELP UTILITIES:
 - `help`: [33mView WYX-CLI Documentation[37m
-- `explain`: [33mExplain a bash command[37m
+- `explain $(<command?>)`: [33mExplain a bash command[37m
 - `ask-gpt`: [33mStart a conversation with ChatGPT[37m
-- `google`: [33mGoogle a query[37m
+- `google <query?>`: [33mGoogle a query[37m
 
diff --git a/src/data/.cache/cmdinfo.term.wyx b/src/data/.cache/cmdinfo.term.wyx
@@ -10,12 +10,12 @@
 - list-deps: [33mList the project dependencies[37m
 
 [34mDIRECTORY NAVIGATION:[37m
-- cd: [33mNavigate Directory Aliases[37m
+- cd <mydir?>: [33mNavigate Directory Aliases[37m
 - back: [33mGo Back A Directory[37m
 
 [34mCODE:[37m
-- run: [33mRun Script Aliases[37m
-- vsc: [33mOpen Directory Aliases in VSCode[37m
+- run <myscript>: [33mRun Script Aliases[37m
+- vsc <mydir>: [33mOpen Directory Aliases in VSCode[37m
 
 [34mGIT AUTOMATION:[37m
 - ginit: [33mInitialise Git Repository[37m
@@ -24,9 +24,9 @@
 - mpull: [33mCheckout-Pull Git Changes From Master/Main Branch[37m
 - commits: [33mView Your Branch Git Commits[37m
 - lastcommit: [33mView Your Last Commit & Copy It's ID[37m
-- nb: [33mCheckout-Add-Commit-Push A New Git Branch[37m
+- nb <branch-name?>: [33mCheckout-Add-Commit-Push A New Git Branch[37m
 - pr: [33mOpen A Pull Request From Your Current Git Branch on GitHub[37m
-- bpr: [33mCheckout-Add-Commit-Push A New Git Branch & Open A PR For It On GitHub[37m
+- bpr <branch-name?>: [33mCheckout-Add-Commit-Push A New Git Branch & Open A PR For It On GitHub[37m
 - pp: [33mPull-Push Git Changes to Current Branch[37m
 
 [34mURLs:[37m
@@ -37,7 +37,7 @@
 - prs: [33mView Your Repository PRs On GitHub[37m
 - notifs: [33mView Your GitHub Notifications[37m
 - profile: [33mView Your GitHub Profile[37m
-- org: [33mView Your GitHub Organisation[37m
+- org <myorg?>: [33mView Your GitHub Organisation[37m
 
 [34mMY DATA:[37m
 - user: [33mView Your User Configuration[37m
@@ -53,7 +53,7 @@
 
 [34mENV/KEYSTORE:[37m
 - keystore: [33mAdd a key-value pair to your '.env' keystore[37m
-- setup: [33mSetup WYX-CLI Third Party API-based utilities[37m
+- setup <smart_commit>: [33mSetup WYX-CLI Third Party API-based utilities[37m
 
 [34mFILE UTILITIES:[37m
 - find: [33mRegex Search Current Directory For File[37m
@@ -73,14 +73,14 @@
 - upscale: [33mScale up an image (uses no smoothing)[37m
 
 [34mTEXT UTILITIES:[37m
-- genpass: [33mGenerate A Random Password[37m
+- genpass <pass-length?>: [33mGenerate A Random Password[37m
 - genhex: [33mGenerate A Random Hex String[37m
 - genb64: [33mGenerate A Random Base64 String[37m
 - lastcmd: [33mCopy Your Last Command To Your Clipboard[37m
-- copy: [33mCopy output of a command to clipboard[37m
+- copy <command?>: [33mCopy output of a command to clipboard[37m
 
 [34mWEB UTILITIES:[37m
-- webtext: [33mRead-only websites in your terminal[37m
+- webtext <url?>: [33mRead-only websites in your terminal[37m
 
 [34mMISC UTILITIES:[37m
 - weather: [33mView the weather forecast for your location in the terminal[37m
@@ -89,7 +89,7 @@
 
 [34mHELP UTILITIES:[37m
 - help: [33mView WYX-CLI Documentation[37m
-- explain: [33mExplain a bash command[37m
+- explain $(<command?>): [33mExplain a bash command[37m
 - ask-gpt: [33mStart a conversation with ChatGPT[37m
-- google: [33mGoogle a query[37m
+- google <query?>: [33mGoogle a query[37m
 
diff --git a/src/data/arg_scripts.csv b/src/data/arg_scripts.csv
@@ -1,9 +1,9 @@
 id,path,name,public,args,category_id
 sys-info,sys-info,"Get Detailed System Information",true,,sys
-cd,cd,"Navigate Directory Aliases",true,,nav
+cd,cd,"Navigate Directory Aliases",true,<mydir?>,nav
 back,back,"Go Back A Directory",true,,nav
-run,run,"Run Script Aliases",true,"<myscript>",code
-vsc,vsc,"Open Directory Aliases in VSCode",true,"<mydir>",code
+run,run,"Run Script Aliases",true,<myscript>,code
+vsc,vsc,"Open Directory Aliases in VSCode",true,<mydir>,code
 genpass,genpass,"Generate A Random Password",true,"<pass-length?>",tutil
 genhex,genhex,"Generate A Random Hex String",true,,tutil
 genb64,genb64,"Generate A Random Base64 String",true,,tutil
@@ -22,11 +22,11 @@ prs,prs,"View Your Repository PRs On GitHub",true,,urls
 notifs,notifs,"View Your GitHub Notifications",true,,urls
 commits,commits,"View Your Branch Git Commits",true,,git
 lastcommit,lastcommit,"View Your Last Commit & Copy It's ID",true,,git
-nb,nb,"Checkout-Add-Commit-Push A New Git Branch",true,,git
+nb,nb,"Checkout-Add-Commit-Push A New Git Branch",true,"<branch-name?>",git
 pr,pr,"Open A Pull Request From Your Current Git Branch on GitHub",true,,git
-bpr,bpr,"Checkout-Add-Commit-Push A New Git Branch & Open A PR For It On GitHub",true,,git
+bpr,bpr,"Checkout-Add-Commit-Push A New Git Branch & Open A PR For It On GitHub",true,"<branch-name?>",git
 profile,profile,"View Your GitHub Profile",true,,urls
-org,org,"View Your GitHub Organisation",true,,urls
+org,org,"View Your GitHub Organisation",true,<myorg?>,urls
 help,help,"View WYX-CLI Documentation",true,,hutil
 user,user,"View Your User Configuration",true,,mydata
 mydirs,mydirs,"View Your Directory Aliases Configuration",true,,mydata
@@ -51,15 +51,15 @@ decrypt,decrypt,"Decrypt a GPG-encrypted file",true,,futil
 weather,weather,"View the weather forecast for your location in the terminal",true,,mutil
 moon,moon,"View the moon phase",true,,mutil
 leap-year,leap-year,"Check when the next leap year is",true,,mutil
-webtext,webtext,"Read-only websites in your terminal",true,,wutil
-explain,explain,"Explain a bash command",true,,hutil
+webtext,webtext,"Read-only websites in your terminal",true,<url?>,wutil
+explain,explain,"Explain a bash command",true,$(<command?>),hutil
 ask-gpt,ask-gpt,"Start a conversation with ChatGPT",true,,hutil
-google,google,"Google a query",true,,hutil
+google,google,"Google a query",true,<query?>,hutil
 install-deps,install-deps,"Install WYX-CLI dependencies",true,,deps
 keystore,keystore,"Add a key-value pair to your '.env' keystore",true,,env
-setup,setup,"Setup WYX-CLI Third Party API-based utilities",true,,env
+setup,setup,"Setup WYX-CLI Third Party API-based utilities",true,"<smart_commit>",env
 update-stdout,img_stdout,"Output wyx STDOUT to an image",false
-copy,copy,"Copy output of a command to clipboard",true,,tutil
+copy,copy,"Copy output of a command to clipboard",true,<command?>,tutil
 update-deps,update-deps,"Update the project dependencies",true,,deps
 list-deps,list-deps,"List the project dependencies",true,,deps
 update-readme,update_readme,"Auto-update the project's readme with the available commands",false,,