https://github.com/JMOrbegoso/PSWindowsDotfiles
Create and Run 🚀 Dotfiles projects for Windows 10/11
https://github.com/JMOrbegoso/PSWindowsDotfiles
powershell
Last synced: 3 months ago
JSON representation
Create and Run 🚀 Dotfiles projects for Windows 10/11
- Host: GitHub
- URL: https://github.com/JMOrbegoso/PSWindowsDotfiles
- Owner: JMOrbegoso
- License: gpl-3.0
- Created: 2022-11-20T16:38:27.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-26T15:26:47.000Z (9 months ago)
- Last Synced: 2025-04-15T15:12:04.944Z (6 months ago)
- Topics: powershell
- Language: PowerShell
- Homepage:
- Size: 132 KB
- Stars: 19
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: docs/README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - JMOrbegoso/PSWindowsDotfiles - Create and Run 🚀 Dotfiles projects for Windows 10/11 (PowerShell)
README
PSWindowsDotfiles
Create and Run 🚀 Dotfiles projects for Windows 10/11
## 💻 Install
Install it from the [PowerShell Gallery](https://www.powershellgallery.com/packages/PSWindowsDotfiles/):
```PowerShell
Install-Module -Name "PSWindowsDotfiles" -Repository "PSGallery" -Scope "AllUsers";
```
## 🗺️ Usage
1. Import PSWindowsDotfiles:
```PowerShell
Import-Module "PSWindowsDotfiles";
```
2. May you need to configure the Execution Policy:
```PowerShell
Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass;
```
3. Create a new Dotfiles project:
```PowerShell
New-Dotfiles "$HOME\OneDrive";
```
4. Build a super-duper Dotfiles project according to your needs:
```Explorer
Dotfiles
│
│── Apps
│ │── git
│ │── powershell
│ │── vscode
│ │── windows-terminal
│ └── winfetch
│
│── Base
│── Clean
│── Helpers
│── Langs
│── OS
│── Shell
│ │── Exports
│ │── Functions
│ │── Images
│ │── Scripts
│ └── Themes
│
└── Dotfiles.ps1
```
5. Run it 🚀:
```PowerShell
Install-Dotfiles "$HOME\OneDrive\Dotfiles";
```
## 🗺️ Try the example repository before creating your own
1. Clone the repo:
```PowerShell
git clone https://github.com/JMOrbegoso/PSWindowsDotfiles-Example.git $HOME\PSWindowsDotfiles-Example;
```
2. Open any Windows PowerShell host console (Except Windows Terminal) with administrator rights and install it:
```PowerShell
Install-Dotfiles $HOME\PSWindowsDotfiles-Example;
```
## 👤 Author
**JMOrbegoso:**
- Website: [www.jmorbegoso.dev](https://www.jmorbegoso.dev)
- Blog: [blog.jmorbegoso.dev](https://blog.jmorbegoso.dev)
- Github: [@JMOrbegoso](https://github.com/JMOrbegoso/)
- LinkedIn: [@jmorbegosodev](https://www.linkedin.com/in/jmorbegosodev/)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/JMOrbegoso/PSWindowsDotfiles/issues/).
## 🌟Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2023 [JMOrbegoso](https://github.com/JMOrbegoso).
This project is [GNU](https://github.com/JMOrbegoso/PSWindowsDotfiles/blob/main/LICENSE) licensed.