starred/msoffice-removal-tool-Admonstrator
1
0
Fork 0
mirror of https://github.com/Admonstrator/msoffice-removal-tool.git synced 2026-04-17 15:43:24 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update README and add funding information; enhance badge update workflow

Browse Source
This commit is contained in:
Aaron Viehl
2025-12-12 21:43:26 +01:00
parent d0c16c6c29
commit dd385c551e
5 changed files with 526 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

220
readme.md
View File

@@ -1,53 +1,205 @@
# Microsoft Office Removal Tool
<div align="center">
```plain
__ _ _ _ ___ _
/ _(_)_ __ __ _| | ___| |_ ___ _ __ / __\_ _ ___| |_ ___ _ __ _ _
\ \| | '_ \ / _` | |/ _ \ __/ _ \| '_ \ / _\/ _` |/ __| __/ _ \| '__| | | |
_\ \ | | | | (_| | | __/ || (_) | | | | / / | (_| | (__| || (_) | | | |_| |
\__/_|_| |_|\__, |_|\___|\__\___/|_| |_| \/ \__,_|\___|\__\___/|_| \__, |
|___/ |___/
## Microsoft Office Removal Tool
Microsoft Office Removal Tool
by Aaron Viehl (Singleton Factory GmbH)
singleton-factory.de
```
**Remove Office installations with ease!**
## Synopsis
[![Latest Release](https://img.shields.io/github/v/release/Admonstrator/msoffice-removal-tool?style=for-the-badge&logo=github&color=blue)](https://github.com/Admonstrator/msoffice-removal-tool/releases/latest) [![License](https://img.shields.io/github/license/Admonstrator/msoffice-removal-tool?style=for-the-badge)](LICENSE) [![Stars](https://img.shields.io/github/stars/Admonstrator/msoffice-removal-tool?style=for-the-badge)](https://github.com/Admonstrator/msoffice-removal-tool/stargazers)
This script downloads the current Office uninstaller from Microsoft and tries to remove all Office installations on this computer.
---
If you wish it tries to install the newest Office365 build as well.
## 💖 Support the Project
You can choose between 2 methods of uninstalling:\
Default method will use the [Microsoft Support and Recovery Assistant (SaRA)](https://docs.microsoft.com/en-us/office365/troubleshoot/administration/sara-command-line-version) for uninstalling.\
By using `-UseSetupRemoval` the Office365 setup method will be used.
If you find this tool helpful, consider supporting its development:
## Parameter
[![GitHub Sponsors](https://img.shields.io/badge/GitHub-Sponsors-EA4AAA?style=for-the-badge&logo=github)](https://github.com/sponsors/admonstrator) [![Buy Me A Coffee](https://img.shields.io/badge/Buy%20Me%20A%20Coffee-FFDD00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black)](https://buymeacoffee.com/admon) [![Ko-fi](https://img.shields.io/badge/Ko--fi-FF5E5B?style=for-the-badge&logo=ko-fi&logoColor=white)](https://ko-fi.com/admon) [![PayPal](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white)](https://paypal.me/aaronviehl)
| Parameter | Usage |
|------------------------|-------------------------------------------------------------------------|
| -InstallOffice365 | The script will try to install the newest Office365 build after removal |
| -SuppressReboot | No reboot will be executed after script is done |
| -UseSetupRemoval | Will use the official Office365 setup instead of SaRA |
| -RunAgain | Will skip the stage mechanism - whole script will run again |
| -Force | Non-interactive - No user interaction required |
| -SecondsToReboot [int] | Seconds until the computer will reboot |
</div>
## Example
---
``.\msoffice-removal-tool.ps1 -InstallOffice365 -SuppressReboot -Force``
## 📖 About
## Stage mechanism
This script downloads the current Office uninstaller from Microsoft and automatically removes all Office installations on your computer.
To make sure that the program will only do the necessary parts a _stage mechanism_ is builtin. After every stage a registry value will be written to ``HKLM:\Software\OEM\Singleton-Factory-GmbH\M365\Install\CurrentStage``
The script features two removal methods and can optionally install the newest Office 365 build after removal.
To overwrite all stages and restart the whole script use ``-RunAgain``.
Created by [Aaron Viehl](https://github.com/Admonstrator) for the community.
## Usage
> ⚠️ **Disclaimer** – This is an independent project, not officially affiliated with Microsoft
You may use this script without explicit download:
---
## ✨ Features
- 🚀 **Automatic Removal** – Removes all Office installations from your computer
- 🔄 **Flexible Methods** – Choose between SaRA or Office365 setup removal
- 📦 **Optional Installation** – Install Office365 after removal if desired
- 🛡️ **Safe Processing** – Built-in stage mechanism to track progress
- ⚡ **Flexible Options** – Multiple parameters for customized removal
- 🔄 **Automatic Reboot** – Optional automatic reboot after completion
---
## 📋 Requirements
| Requirement | Details |
|-------------|---------|
| **OS** | Windows (Windows 10 or later recommended) |
| **PowerShell** | PowerShell 5.0 or later |
| **Permissions** | Administrator privileges required |
| **Internet** | Required for downloading Office uninstaller |
---
## 🚀 Quick Start
Run the script without cloning the repository:
```powershell
iwr https://raw.githubusercontent.com/Admonstrator/msoffice-removal-tool/main/msoffice-removal-tool.ps1 -OutFile msoffice-removal-tool.ps1; powershell -ExecutionPolicy Bypass .\msoffice-removal-tool.ps1
```
---
## 🎛️ Parameters
The `msoffice-removal-tool.ps1` script supports the following parameters:
| Parameter | Description |
|-----------|-------------|
| `-InstallOffice365` | The script will try to install the newest Office365 build after removal |
| `-SuppressReboot` | No reboot will be executed after script is done |
| `-UseSetupRemoval` | Will use the official Office365 setup instead of SaRA for uninstalling |
| `-RunAgain` | Will skip the stage mechanism - whole script will run again |
| `-Force` | Non-interactive mode - No user interaction required |
| `-SecondsToReboot [int]` | Seconds until the computer will reboot (default: 120) |
---
## 📚 Usage Examples
### Standard Removal
Remove Office with the default SaRA method:
```powershell
.\msoffice-removal-tool.ps1
```
### Removal with Reinstallation
Remove Office and install the latest Office365 build:
```powershell
.\msoffice-removal-tool.ps1 -InstallOffice365
```
### Force Removal Without Reboot
Skip all prompts and prevent automatic reboot:
```powershell
.\msoffice-removal-tool.ps1 -Force -SuppressReboot
```
### Using Office Setup Removal
Use the Office365 setup method instead of SaRA:
```powershell
.\msoffice-removal-tool.ps1 -UseSetupRemoval -Force
```
### Complete Unattended Removal with Reinstallation
For fully unattended operation with reinstallation:
```powershell
.\msoffice-removal-tool.ps1 -InstallOffice365 -Force -SecondsToReboot 60
```
### Restarting the Entire Process
To skip the stage mechanism and run the entire script again:
```powershell
.\msoffice-removal-tool.ps1 -RunAgain -Force
```
---
## 🔍 Key Features Explained
### 🎯 Stage Mechanism
The script uses a built-in stage mechanism to ensure it only performs necessary steps and doesn't repeat work unnecessarily.
After every stage, a registry value is written to:
```
HKLM:\Software\OEM\Singleton-Factory-GmbH\M365\Install\CurrentStage
```
The mechanism is:
- ✅ Applied automatically
- ✅ Persistent across script restarts
- ✅ Can be overridden with `-RunAgain` parameter
### 🔧 Removal Methods
**Default Method (SaRA):**
- Uses the [Microsoft Support and Recovery Assistant](https://docs.microsoft.com/en-us/office365/troubleshoot/administration/sara-command-line-version)
- Recommended for most users
- Less intrusive than setup method
**Setup Method:**
- Uses the official Office365 setup
- More thorough removal
- Enabled with `-UseSetupRemoval` parameter
### 📦 Office365 Installation
When using `-InstallOffice365`, the script will:
- ✅ Automatically download the latest Office365 build
- ✅ Install Office365 after removal completes
- ✅ Configure the XML installation files from the `office365-installer/` directory
---
## 💡 Getting Help
Need assistance or have questions?
- 🐛 [Report issues on GitHub](https://github.com/Admonstrator/msoffice-removal-tool/issues) – Bug reports and feature requests
- 📧 Contact via GitHub – For private inquiries
---
## ⚠️ Disclaimer
This script is provided **as-is** without any warranty. Use it at your own risk.
It may potentially:
- 🔥 Remove important files or configurations
- 🔥 Cause system instability
- 🔥 Require manual recovery steps
**You have been warned!**
Always read the documentation carefully and understand what a script does before running it. Create a system restore point before executing this script.
---
## 📜 License
This project is licensed under the **MIT License** – see the [LICENSE](LICENSE) file for details.
---
<div align="center">
**Made with ❤️ by [Admonstrator](https://github.com/Admonstrator)**
⭐ If you find this useful, please star the repository!
</div>