Skip to content

Commit

Permalink
Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
felipealfonsog committed Dec 8, 2023
1 parent 530051c commit 7b2277c
Show file tree
Hide file tree
Showing 5 changed files with 284 additions and 17 deletions.
155 changes: 138 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
# C-VipNX
# C-VipNX* 💻 [(Experimental Project)](#important-experimental-project)*
Shell Vip Utility written in C for *NX Systems.
Simple: Vip shell to avoid usage of sudo.

🚀 Welcome to VIP Shell, where simplicity meets power in your command line experience. VIP Shell is a sleek and interactive command line shell designed for users who crave efficiency and elegance. With its user-friendly interface, VIP Shell empowers you to navigate and execute commands seamlessly, providing a personalized and enjoyable interaction with your Unix-like environment. Whether you're a seasoned developer or a command line enthusiast, VIP Shell is your gateway to a sophisticated and efficient command line journey. Elevate your terminal experience with VIP Shell – where every command feels like a VIP moment! 💻✨

![Version](https://img.shields.io/github/release/NymexData/C-VipNX.svg?style=flat&color=blue)
[![Open Source? Yes!](https://badgen.net/badge/Open%20Source%20%3F/Yes%21/blue?icon=github)](https://github.com/Naereen/badges/)

![Main Language](https://img.shields.io/github/languages/top/felipealfonsog/C-VipNX.svg?style=flat&color=blue)
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)

[![Vim](https://img.shields.io/badge/--019733?logo=vim)](https://www.vim.org/)
[![Visual Studio Code](https://img.shields.io/badge/--007ACC?logo=visual%20studio%20code&logoColor=ffffff)](https://code.visualstudio.com/)

<!--
[![GPL license](https://img.shields.io/badge/License-GPL-blue.svg)](http://perso.crans.org/besson/LICENSE.html)
-->

<sub>* This is currently an experimental phase where the primary focus is on making the system functional and establishing a practical and logical pathway that aligns with both my vision and the project's goals. It might contain errors, bugs, etc. Many other non-core elements of the project are considered secondary.</sub>

### Table of Contents

- [Getting Started](#getting-started)
Expand All @@ -26,13 +34,127 @@ Simple: Vip shell to avoid usage of sudo.

![Sshot macOS](images/sshot-macos.png)

#### Key Features:

- Command Execution: Execute various shell commands by entering them in the command prompt.

- Change Directory (cd): Change the current working directory using the cd command followed by the target directory.

- Command History: Keep track of the last executed commands, accessible through the --last-commands option.

- File Tracking: Record the paths of files related to each executed command, accessible through the --last-files option.

- Help Option (--vip-help): Display a help message with information about available options and commands, including exit to end the VIP Shell.

- Sudo Privileges Check: Request sudo privileges at the beginning of the program to ensure the execution of privileged commands.

- Exit Command: Allow the user to exit the VIP Shell using the exit command.

- Clean and Readable Code: Maintain a clean and readable code structure for easy modification and future development.



#### Installation
#### Via AUR using YAY

[![AUR](https://img.shields.io/aur/version/vipshell)](https://aur.archlinux.org/packages/vipshell)

<!--
[![AUR](https://img.shields.io/aur/version/vipshell.svg)](https://aur.archlinux.org/packages/vipshell)
-->

<!--
https://aur.archlinux.org/packages/vipshell
-->

Term PDF Viewer is available on AUR (Arch User Repository), and it can be installed using the `yay` package manager. Follow the steps below to install Term Notes:

1. Make sure you have `yay` installed. If not, you can install it with the following command:

```
sudo pacman -S yay
```
Once yay is installed, you can install Vip shell by running the following command:

```
yay -S vipshell
```
This command will automatically fetch the package from AUR and handle the installation process for you.

#### Install using a BASH script!

[![Install C-VipNX](https://img.shields.io/badge/Install-C-VipNX-brightgreen)](#)


To install Vip shell, simply run the installer script available [here](https://github.com/felipealfonsog/C-VipNX/raw/main/installer.sh).

Or just Copy - Paste in your terminal and use -curl- to start downloading the installer:

```
curl -O https://raw.githubusercontent.com/felipealfonsog/C-VipNX/main/installer.sh
```

If you want to use -wget- just copy/paste this line:

```
wget https://github.com/felipealfonsog/C-VipNX/raw/main/installer.sh
```

On macOS to download - wget - just install it with Homebrew:

```
brew install wget
```

#### Important note when installing:

If you encounter issues executing the file in the terminal, like this message "-bash: ./installer.sh: Permission denied", follow these simple steps to fix it:

1. Open your terminal.
2. Navigate to the directory where the installer script is located using the `cd` command.
3. Run the following command to grant execute permission to the installer script:

```
chmod +x installer.sh
```

4. Now you can run the installer without any problems.

```
./installer.sh
```
NOTE: The script will ask for -sudo permissions-. Just simply type in macOS your macOS user password, and in Linux your -sudo- password.

Now type 'vipshell' in the terminal and enjoy using Vip shell! 😊🚀

Feel free to reach out if you need any further assistance!

#### Updating with the script:
If you want to update term-notes in your system, re-run the script:

```
./installer.sh
```
Please note that if you encounter any issues or have suggestions, feel free to raise an issue on the [Vip shell repository](https://github.com/felipealfonsog/C-VipNX/issues). Your feedback is invaluable!

Thank you for joining me on this journey, and I hope Vip shell brings value to your life and workflow. Let's continue making technology accessible and enjoyable for everyone!


#### 📝Important (Experimental Project)

[![Experimental Project](https://img.shields.io/badge/Project-Type%3A%20Experimental-blueviolet)](#)

VIP Shell invites you to redefine your terminal experience. Whether you're a developer, enthusiast, or curious user, dive into the future of terminal interactions with VIP Shell!

<p>This project is still in its experimental stage and may have limitations in terms of features and compatibility. Use at your own discretion.</p>



### Prerequisites

#### Instructions

You need to install tcsh in your Linux/Unix like flavor.

| gunzip vip.c.gz

| sudo gcc -o vip vip.c (compilation)

Expand Down Expand Up @@ -101,29 +223,28 @@ git clone -b <branchname> <remote-repo-url>
---

#### Creator / Maintainer

Computer Science Engineer:
Felipe Alfonso González L. ([felipealfonsog](https://github.com/felipealfonsog))

If you have any questions, comments, or concerns, feel free to contact me by Email [f.alfonso@res-ear.ch](mailto:f.alfonso@res-ear.ch).


#### Support

If you like my content or find this code useful, give it a :star: or support me by buying me a coffee :coffee::grinning:
#### 🤝 Support and Contributions

[![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-Donate-orange.svg)](https://www.buymeacoffee.com/felipealfonsog)
If you find this project helpful and would like to support its development, there are several ways you can contribute:

- **Code Contributions**: If you're a developer, you can contribute by submitting pull requests with bug fixes, new features, or improvements. Feel free to fork the project and create your own branch to work on.
- **Bug Reports and Feedback**: If you encounter any issues or have suggestions for improvement, please open an issue on the project's GitHub repository. Your feedback is valuable in making the project better.
- **Documentation**: Improving the documentation is always appreciated. If you find any gaps or have suggestions to enhance the project's documentation, please let me know.

---

#### Additional Information
[![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-%E2%98%95-FFDD00?style=flat-square&logo=buy-me-a-coffee&logoColor=black)](https://www.buymeacoffee.com/felipealfonsog)
[![PayPal](https://img.shields.io/badge/Donate%20with-PayPal-00457C?style=flat-square&logo=paypal&logoColor=white)](https://www.paypal.com/felipealfonsog)
[![GitHub Sponsors](https://img.shields.io/badge/Sponsor%20me%20on-GitHub-%23EA4AAA?style=flat-square&logo=github-sponsors&logoColor=white)](https://github.com/sponsors/felipealfonsog)

- [brew](https://brew.io/)
- [GCC](https://gcc.gnu.org/)
Your support and contributions are greatly appreciated! Thank you for your help in making this project better. If you need to mail me, this is the way: f.alfonso@res-ear.ch (I'm Felipe, the Computer Science Engineer behind this idea. Cheers!)

#### Developed with:

[![Vim](https://img.shields.io/badge/--019733?logo=vim)](https://www.vim.org/)
[![Visual Studio Code](https://img.shields.io/badge/--007ACC?logo=visual%20studio%20code&logoColor=ffffff)](https://code.visualstudio.com/)
#### 📄 License

This project is licensed under the [MIT License](LICENSE).

122 changes: 122 additions & 0 deletions installer.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
#!/bin/bash

: '
▒█░░▒█ ░▀░ █▀▀█ ▒█▀▀▀█ █░░█ █▀▀ █░░ █░░
░▒█▒█░ ▀█▀ █░░█ ░▀▀▀▄▄ █▀▀█ █▀▀ █░░ █░░
░░▀▄▀░ ▀▀▀ █▀▀▀ ▒█▄▄▄█ ▀░░▀ ▀▀▀ ▀▀▀ ▀▀▀
*************************************************
The VIP Shell provides a basic yet functional command-line
environment with added features for command history and file
tracking, enhancing the user experience in a Unix-like shell.
*************************************************
* Developed and engineered by:
* Felipe Alfonso Gonzalez <f.alfonso@res-ear.ch>
* Computer Science Engineer
* Chile
*************************************************
* Important Notes:
* - The application has been tested on Linux and macOS.
* - For Windows, additional configurations may be required.
* - Make sure to fulfill the prerequisites before running the application.
* - For more information, please refer to the project documentation.
*************************************************
'

welcome_message() {
echo
echo "▒█░░▒█ ░▀░ █▀▀█ ▒█▀▀▀█ █░░█ █▀▀ █░░ █░░"
echo "░▒█▒█░ ▀█▀ █░░█ ░▀▀▀▄▄ █▀▀█ █▀▀ █░░ █░░"
echo "░░▀▄▀░ ▀▀▀ █▀▀▀ ▒█▄▄▄█ ▀░░▀ ▀▀▀ ▀▀▀ ▀▀▀"
echo "---------------------------------------------------"
echo "VIP Shell - Simple and Interactive Command Line Shell"
echo "---------------------------------------------------"
echo "* Welcome to the VIP Shell, a user-friendly shell"
echo "* for executing commands in a Unix-like environment."
echo "---------------------------------------------------"
echo
echo "╭─────────────────── TERMS OF USE ─────────────────╮"
echo "│ This software is licensed under - MIT and BSD-3 │"
echo "│ Restrictive Licenses. │"
echo "│ Developed by Felipe Alfonso González │"
echo "│ Computer Science Engineer │"
echo "│ GitHub: github.com/felipealfonsog │"
echo "╰──────────────────────────────────────────────────╯"
echo
echo "Welcome to the VIP Shell Installer!"
echo "This script will install the VIP Shell program on your system."
echo "Please make sure you have the necessary permissions to perform the installation."
read
}


download_source_vipshellp() {
local os=$(uname -s)
local installer_url="https://github.com/felipealfonsog/C-VipNX/raw/main/vipshell.c"

if [[ "$os" == "Darwin" || "$os" == "Linux" ]]; then
echo "Downloading the shell vip source..."
curl -o shellvip.c -L "$installer_url"
else
echo "Unsupported platform."
exit 1
fi
}

compile_source_vipshell() {
echo "Compiling source ..."

gcc -o vipshell vipshell.c || {
echo "Error: Compilation failed."
exit 1
}
sudo chmod +x vipshell
echo "Compilation successful."
}

move_to_bin_directory() {
echo "Moving compiled binary to bin directory..."

sudo mv vipshell "/usr/local/bin"

sudo chmod +x "/usr/local/bin/vipshell"

echo "Binary moved to '/usr/local/bin' and permissions set."
}


run_vipshell() {
echo "Running the Vip Shell from Bash script..."

/usr/local/bin/vipshell
#echo "Vip Shell executed."
}

remove_compiled_file() {
echo "Removing unnecessary files..."
rm -rf *.c
rm installer.sh
echo "Cleanup complete."
}

set_permissions() {
echo "Setting permissions..."

# chmod 755 ./

echo "Permissions set."
}



welcome_message
download_source_vipshell
compile_source_vipshell
move_to_bin_directory
# run_shellvip
remove_compiled_file
# set_permissions

echo "Vipshell has been successfully installed as 'vipshell' command!"
24 changes: 24 additions & 0 deletions src/AUR/PKGBUILD
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Mantenedor: Felipe Alfonso Gonzalez <f.alfonso@res-ear.ch>
pkgname=vipshell
pkgver=1.2.4
pkgrel=1
pkgdesc="VIP Shell is a cutting-edge, open-source terminal environment that elevates your command-line experience with enhanced features and personalized interactions."
arch=('x86_64')
url="https://github.com/felipealfonsog/C-VipNX"
license=('MIT')
depends=('gcc')
source=("https://github.com/felipealfonsog/C-VipNX/archive/refs/tags/v.${pkgver}.tar.gz")
sha256sums=('7111ba0d04ae16d01fc590e3838edf22e2afef69db2be522775e2ede0659f76a')

prepare() {
tar xf "v.${pkgver}.tar.gz" -C "$srcdir" --strip-components=1
# cp "$srcdir"/vipshell.c "$srcdir"/C-VipNX-v."$pkgver"/
}
build() {
cd "$srcdir"/C-VipNX-v."${pkgver}"
gcc -o vipshell "$srcdir"/C-VipNX-v."${pkgver}"/vipshell.c
}
package() {
install -Dm755 "$srcdir"/C-VipNX-v."${pkgver}"/vipshell "${pkgdir}/usr/local/bin/vipshell"

}
File renamed without changes.
File renamed without changes.

0 comments on commit 7b2277c

Please sign in to comment.