/PSWindowsDotfiles

Create and Run πŸš€ Dotfiles projects for Windows 10/11

Primary LanguagePowerShellGNU General Public License v3.0GPL-3.0

PSWindowsDotfiles

Create and Run πŸš€ Dotfiles projects for Windows 10/11


πŸ’» Install

Install it from the PowerShell Gallery:

Install-Module -Name "PSWindowsDotfiles" -Repository "PSGallery" -Scope "AllUsers";

πŸ—ΊοΈ Usage

  1. Import PSWindowsDotfiles:

    Import-Module "PSWindowsDotfiles";
  2. May you need to configure the Execution Policy:

    Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass;
  3. Create a new Dotfiles project:

    New-Dotfiles "$HOME\OneDrive";
  4. Build a super-duper Dotfiles project according to your needs:

    Dotfiles
    β”‚
    │── Apps
    β”‚    │── git
    β”‚    │── powershell
    β”‚    │── vscode
    β”‚    │── windows-terminal
    β”‚    └── winfetch
    β”‚
    │── Base
    │── Clean
    │── Helpers
    │── Langs
    │── OS
    │── Shell
    β”‚     │── Exports
    β”‚     │── Functions
    β”‚     │── Images
    β”‚     │── Scripts
    β”‚     └── Themes
    β”‚
    └── Dotfiles.ps1
    
  5. Run it πŸš€:

    Install-Dotfiles "$HOME\OneDrive\Dotfiles";

πŸ—ΊοΈ Try the example repository before creating your own

  1. Clone the repo:

    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:

    Install-Dotfiles $HOME\PSWindowsDotfiles-Example;

πŸ‘€ Author

JMOrbegoso:

🀝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

🌟Show your support

Give a ⭐️ if this project helped you!

πŸ“ License

Copyright Β© 2023 JMOrbegoso.
This project is GNU licensed.