https://github.com/douxxtech/doual
DouAl - Alias management tool for Unix-like systems (MacOS, Linux)
https://github.com/douxxtech/doual
Last synced: about 1 year ago
JSON representation
DouAl - Alias management tool for Unix-like systems (MacOS, Linux)
- Host: GitHub
- URL: https://github.com/douxxtech/doual
- Owner: douxxtech
- License: mit
- Created: 2025-02-26T15:47:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-26T15:48:12.000Z (over 1 year ago)
- Last Synced: 2025-03-28T19:44:40.890Z (about 1 year ago)
- Language: JavaScript
- Size: 4.88 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# 🚀 DouAl - Alias Manager
DouAl is a simple and efficient alias manager that allows you to create, list, and delete aliases for your command line. It works on macOS and most Linux distributions.
## 📀 Requirements
To use DouAl, you need the following:
**Base Requirements:**
- [Node.js](https://nodejs.org/en)
- [npm](https://www.npmjs.com/package/npm)
**Packages:**
- [colors](https://www.npmjs.com/package/colors)
- [readline-sync](https://www.npmjs.com/package/readline-sync)
*Note: All these packages are available on [npmjs.org](https://npmjs.com) and can be installed with the command `npm install `.*
## 🖥 Installation
To install DouAl, follow these steps:
1. Ensure you have [Node.js](https://nodejs.org/en) and [npm](https://www.npmjs.com/package/npm) installed on your device.
2. Open a terminal.
3. Install DouAl with npm:
```bash
npm install -g DouAl
```
## ⚡️ Using DouAl
### Create an Alias
You can create an alias using the following command:
```bash
dal create [-a ] [-r ]
```
**Options:**
- `-a, --args `: Arguments for the initial command
- `-r, --root `: Run as root
**Example:**
```bash
dal create "ls -la" ll -a "--color=auto"
```
### Remove an Alias
You can remove an alias using the following command:
```bash
dal remove
```
**Example:**
```bash
dal remove ll
```
### List All Aliases
You can list all aliases using the following command:
```bash
dal list
```
### Execute an Alias
To execute an alias, simply type the alias name in the terminal:
```bash
```
**Example:**
```bash
ll
```
## 📝 Example Usage
### Creating an Alias
```bash
dal create "ls -la" ll -a "--color=auto"
```
Output:
```
Starting DouAl.js v1.0.0
[i] Creating or updating alias ll...
[✔] Alias ll added to ~/.zshrc
[✔] Alias ll created or updated successfully.
[i] Please reload your terminal for the changes to take effect.
```
### Deleting an Alias
```bash
dal remove ll
```
Output:
```
Starting DouAl.js v1.0.0
[i] Do you want to remove the alias ll? ([Y]/n): y
[i] Removing alias ll...
[✔] Alias ll removed from ~/.zshrc
[✔] Alias ll removed successfully.
[i] Please reload your terminal for the changes to take effect.
```
### Listing All Aliases
```bash
dal list
```
Output:
```
Starting DouAl.js v1.0.0
Alias: ll, Command: ls -la, Options: {"InitialArgs":"","RunAsRoot":false}
```
## 📝 License
This project is licensed under the MIT License.
---
Made with <3 by douxx