Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mathieubesson/my-magic-prompt

Last synced: 7 days ago
JSON representation

Host: GitHub
URL: https://github.com/mathieubesson/my-magic-prompt
Owner: MathieuBesson
Created: 2024-04-02T17:50:45.000Z (8 months ago)
Default Branch: main
Last Pushed: 2024-04-17T09:29:35.000Z (7 months ago)
Last Synced: 2024-04-17T11:28:17.294Z (7 months ago)
Language: Shell
Size: 18.6 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# My Magic Prompt

## Description

My magic prompt is a cli in a terminal that allows you to launch commands that perform certain actions. This project being a student project it is based on precise instructions available here : [Link to Exercise Instructions](./shell-scripting.pdf)

## Prerequisites

### OS

A Linux distribution, WSL, or macOS

### Utilities

![curl](https://img.shields.io/badge/curl-07405E?logo=curl&logoColor=white&labelColor=07405E)
![make](https://img.shields.io/badge/make-427819?logo=gnu&logoColor=white&labelColor=427819)
![mailutils](https://img.shields.io/badge/mailutils-DB4437?logo=maildotcom&logoColor=white&labelColor=DB4437)
![vim](https://img.shields.io/badge/vim-019733?logo=vim&logoColor=white&labelColor=019733)

## Usage

### Start the Prompt

```bash
make my-magic-prompt
```

- To access the prompt, you need to provide a specific login and password, or create your own.

### Running Commands

```bash
[COMMAND] [ARGUMENTS] [OPTIONS]
```

## Available Commands

- **passw**: Change the password with a confirmation prompt.
- **profil**: Displays all your personal information (First Name, Last Name, Age, Email).
- **ls**: Lists visible and hidden files and directories.
- **cd**: Navigate to a newly created directory or return to the previous one.
- **pwd**: Displays the current directory.
- **hour**: Shows the current time.
- **rm**: Deletes a file.
- **rmd**, **rmdir**: Deletes a directory.
- **httpget**: Downloads the HTML source code of a web page and saves it to a specified file. You will be prompted to provide the file name.
- **smtp**: Sends an email with a specified address, subject, and message body.
- **open**: Opens a file directly in the Vim editor, even if the file doesn't exist.
- **age**: Asks for your age and indicates whether you are a minor or an adult.
- **quit**, **exit**: Exits the prompt.
- **help**: Displays available commands.
- **about**: Description of the program.
- **version**, **vers**, **--v**: Displays the prompt's version.

## License

This project is licensed under the GPL License. See the [LICENSE](./LICENSE) file for more details.