-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #45 from hwixley/rename-project
Rename project
- Loading branch information
Showing
59 changed files
with
215 additions
and
215 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,10 @@ | ||
# Contributing to the WIX-CLI | ||
# Contributing to the WYX-CLI | ||
|
||
1. Create a fork of WIX-CLI | ||
1. Create a fork of WYX-CLI | ||
2. Pick up one of the issues if not already underway or assigned. Please comment on the issue that you are working on it, to prevent clashing with other developers. | ||
3. Create a PR from your fork into master and assign @hwixley to review it. | ||
4. @hwixley will review it as soon as he can :) | ||
|
||
## General Code Practice | ||
|
||
- When creating a new command/feature make sure to list it in the list of commands on the `README.md` and the output of the `wix` command in the correct format. | ||
- When creating a new command/feature make sure to list it in the list of commands on the `README.md` and the output of the `wyx` command in the correct format. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,21 @@ | ||
# ⚡️ WIX CLI ⚡️ | ||
# ⚡️ WYX CLI ⚡️ | ||
|
||
Optimize your development productivity in the terminal | ||
|
||
<hr> | ||
|
||
[](https://hwixley.github.io/wix-cli/) [](https://github.com/hwixley/WIX-CLI/actions/workflows/jekyll-gh-pages.yml) [](https://github.com/hwixley/WIX-CLI/actions/workflows/main.yml)<br>   | ||
[](https://hwixley.github.io/wyx-cli/) [](https://github.com/hwixley/WYX-CLI/actions/workflows/jekyll-gh-pages.yml) [](https://github.com/hwixley/WYX-CLI/actions/workflows/main.yml)<br>   | ||
|
||
<hr> | ||
<p align="center"> | ||
<img src="../.generated/wixcli-output-preview.png" style="width: 90%; display: flex; margin: auto"> | ||
<img src="../.generated/wyxcli-output-preview.png" style="width: 90%; display: flex; margin: auto"> | ||
</p> | ||
|
||
<hr> | ||
|
||
## Table of Contents | ||
|
||
- [⚡️ WIX CLI ⚡️](#️-wix-cli-️) | ||
- [⚡️ WYX CLI ⚡️](#️-wyx-cli-️) | ||
- [Table of Contents](#table-of-contents) | ||
- [What It Does](#what-it-does) | ||
- [Why It Was Made](#why-it-was-made) | ||
|
@@ -68,8 +68,8 @@ I am developing this project in my spare time to help developer's across the glo | |
|
||
<ins>The dependencies include:</ins> | ||
|
||
- `openssl` for the [Random String Generation](https://github.com/hwixley/wix-cli#text-utilities) commands. | ||
- `git` for all [Git Automation](https://github.com/hwixley/wix-cli#git-automation) commands. | ||
- `openssl` for the [Random String Generation](https://github.com/hwixley/wyx-cli#text-utilities) commands. | ||
- `git` for all [Git Automation](https://github.com/hwixley/wyx-cli#git-automation) commands. | ||
- Visual Studio Code for the `vsc` code editor command. | ||
- XCode for the `xc` code editor command (only available for Macintosh systems). | ||
- `speedtest` (the Ookla speedtest-cli) for runnning network speed tests. The installation commands for this on MacOS and Debian are in `setup.sh`. | ||
|
@@ -81,13 +81,13 @@ I am developing this project in my spare time to help developer's across the glo | |
1. Clone this repository into a folder of your choice: | ||
|
||
``` | ||
git clone [email protected]:hwixley/WIX-CLI.git | ||
git clone [email protected]:hwixley/WYX-CLI.git | ||
``` | ||
|
||
2. Navigate into the directory: | ||
|
||
``` | ||
cd WIX-CLI | ||
cd WYX-CLI | ||
``` | ||
|
||
3. Give permissions to the setup script and run it: | ||
|
@@ -98,14 +98,14 @@ chmod +x setup.sh && ./setup.sh | |
|
||
4. Reopen your terminal or run `source ~/.bashrc` (`source ~/.zshrc` for unix systems) | ||
|
||
Type `wix` to see the list of commands and start developing some magic! | ||
Type `wyx` to see the list of commands and start developing some magic! | ||
|
||
## Extra Feature Setup | ||
|
||
1. You can use OpenAI's ChatGPT to write commit messages for you (using `git diff` and `git status` outputs) when using the `wix push` command. <i>This requires an OpenAI API key.</i> | ||
1. 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. <i>This requires an OpenAI API key.</i> | ||
|
||
``` | ||
wix setup smart_commit | ||
wyx setup smart_commit | ||
``` | ||
|
||
## Factory-reset Installation | ||
|
@@ -116,7 +116,7 @@ wix setup smart_commit | |
rm -rf <path-of-installation> | ||
``` | ||
|
||
1. Remove the wix-cli script setup in your environment file | ||
1. 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 | ||
|
@@ -125,10 +125,10 @@ rm -rf <path-of-installation> | |
``` | ||
vi ~/.bashrc | ||
``` | ||
- Remove the 2 lines for the wix-cli:<br> | ||
- The first line is a comment: `# WIX-CLI`<br> | ||
- The second line is where the command is actually setup: `alias wix="<path-of-installation>/wix-cli.sh"` | ||
2. Follow the [installation instructions](https://github.com/hwixley/wix-cli#installation) | ||
- Remove the 2 lines for the wyx-cli:<br> | ||
- The first line is a comment: `# WYX-CLI`<br> | ||
- The second line is where the command is actually setup: `alias wyx="<path-of-installation>/wyx-cli.sh"` | ||
2. Follow the [installation instructions](https://github.com/hwixley/wyx-cli#installation) | ||
<hr> | ||
|
@@ -144,7 +144,7 @@ Please note any command with an argument in angle brackets below (ie. `<branch>` | |
<br> | ||
<i>**\*\*Note: all commands below should be preceded by the `wix` command, this was ommitted for readability.\*\***</i> | ||
<i>**\*\*Note: all commands below should be preceded by the `wyx` command, this was ommitted for readability.\*\***</i> | ||
<br> | ||
### Navigation | ||
|
@@ -187,7 +187,7 @@ Please note any command with an argument in angle brackets below (ie. `<branch>` | |
6. `notifs`: go to your GitHub Notifications | ||
7. `profile`: go to your GitHub profile | ||
8. `org <myorg?>`: go to the specified url of the GitHub organization | ||
9. `help`: go to the wix-cli GitHub Pages url for documentation | ||
9. `help`: go to the wyx-cli GitHub Pages url for documentation | ||
### Data for Custom Scripting Logic | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -33,15 +33,15 @@ jobs: | |
# Run the script | ||
- name: Run script file | ||
run: | | ||
chmod +x wix-cli.sh | ||
./wix-cli.sh img_stdout | ||
chmod +x wyx-cli.sh | ||
./wyx-cli.sh img_stdout | ||
shell: bash | ||
|
||
# Commit and push changes | ||
- name: Commit changes | ||
run: | | ||
git config --local user.name "WIX-CLI Bot" | ||
git config --local user.name "WYX-CLI Bot" | ||
git config --local user.email "[email protected]" | ||
git add .generated/wixcli-output-preview.png | ||
git commit -m "GH-Action: Update 'wix' stdout image" | ||
git add .generated/wyxcli-output-preview.png | ||
git commit -m "GH-Action: Update 'wyx' stdout image" | ||
git push |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
.wix-cli-data/ | ||
wix-cli-template.sh | ||
.wyx-cli-data/ | ||
wyx-cli-template.sh | ||
*.pyc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
#!/bin/bash | ||
|
||
complete -W "sys-info update install-deps cd back vsc xc run push pull ginit nb pr bpr commits lastcommit setup repo branch prs actions issues notifs profile org help user myorgs mydirs myscripts todo editd edits newscript fopen find regex rgxmatch ip wifi wpass speedtest hardware-ports genqr upscale genhex genb64 copy lastcmd weather moon explain" wix | ||
complete -W "sys-info update install-deps cd back vsc xc run push pull ginit nb pr bpr commits lastcommit setup repo branch prs actions issues notifs profile org help user myorgs mydirs myscripts todo editd edits newscript fopen find regex rgxmatch ip wifi wpass speedtest hardware-ports genqr upscale genhex genb64 copy lastcmd weather moon explain" wyx |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.