Lapfips_Main_Program

Lapfips_Main_Program is a versatile script designed to handle various tasks efficiently. This program provides several functionalities through different commands and options.

Table of Contents

1. Features
2. Installation
3. Usage
   • Global Options
   • Detailed Command Options
4. Examples
5. Contributing
6. License

Features

The program supports the following functionalities:

• System Updates (-upt)
• File Transfers (-trf, -trfVM)
• Repository Management (-add, -rm)
• File or Repository Opening (-open)
• Run a program with his dependencies (-run)
• Help Display (-help)

Each command is accompanied by its specific set of options to tailor its behavior.

Installation

To use the program, ensure you have the following:

1. A Linux or macOS environment with Bash installed.
2. SCP installed for file transfers.

Clone the repository:

git clone https://github.com/Lapfips/Lapfips_Main_Program.git
cd Lapfips_Main_Program
chmod +x program

Usage

General Syntax

./program [command] [options]

Global Options

Command	Description
-upt	Update repositories, packages, or other systems.
-trf	Transfer files or directories.
-trfVM	Transfer files specific to virtual machines.
-add	Add a new repository or file.
-rm	Remove an existing repository or file.
-open	Open files or repositories.
-help	Display help for commands or options.

Detailed Command Options

-upt

Manage updates. Example syntax:

./program -upt [options]

Option	Description
-a	Update all components.
-p	Update personnal repositories.
-o	Update organizational repositories.
-l	Update laboratory repositories.
-op	Update optional repositories.
-ob	Update obsidian save.
-help	Display help specific to -upt.

-trf

Transfer files or directories. Example syntax:

./program -trf [options]

Option	Description
-help	Display help for file transfer operations.

-add

Add a repository or file. Example syntax:

./program -add [command] <name>

Option	Description
-p	Add a personal repository.
-o	Add an organizational repository.
-op	Add an optional repository.
-l	Add a laboratory repository.
-help	Display help for adding files or repositories.

-rm

Remove repositories or files. Example syntax:

./program -rm [command] <name>

Option	Description
-p	Remove a personal repository.
-o	Remove an organizational repository.
-op	Remove an optional repository.
-l	Remove a laboratory repository.
-help	Display help for removing files or repositories.

-open

Open repositories or files. Example syntax:

./program -open

Option	Description
-help	Display help for opening files or repositories.

Examples

Update All Components

./program -upt -a

Transfer a File

./program -trf -help

Add a New Repository with Auto-Commit

./program -add -category my_repo

Remove a File

./program -rm -category my_repo

Open a Repository

./program -open file_name

Contriburors

• Lapfips (Ethan FARGIER)
• Lapgirl (Valentine REVERTE)
• Layann (Joana BURETH)

Contributing

We welcome contributions! Please follow these steps:

1. Fork the repository.
2. Create a new branch: git checkout -b feature/your-feature-name.
3. Commit your changes: git commit -m 'Add a new feature'.
4. Push to the branch: git push origin feature/your-feature-name.
5. Submit a pull request.

ToDo:

• Implement my ToDo feature
• Create a .env file with the path and informations needed
• Create a .gitignore file

License

This project is licensed under the MIT License. See the LICENSE file for details.