Skip to content

luke-beep/shell-config

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🐚 Shell-Config

License PRs Welcome GitHub last commit GitHub stars GitHub forks

🗂️ Table of Contents


📚 Description


This repository contains my personal configuration for the Windows Terminal. It's designed to optimize my workflow and make terminal operations more efficient.

Note

This shell configuration is designed and optimized for Windows 11. It may not work as intended on other versions of Windows.

📸 Screenshots


Screenshot Screenshot

🚀 Installation


You have two choices for installation. You can either use the automated installation script or manually install the profile. The automated installation script is recommended for most users. However, if you want to manually install the profile, you can follow the manual installation guide.

  • Automated Installation - The automated installation script is the recommended installation method for most users. It's designed to be user-friendly and easy to use. It will automatically install the profile and configure the Windows Terminal. It will also automatically install the required dependencies. You can use the following command to install the profile:
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
iwr -useb https://raw.githubusercontent.com/luke-beep/shell-config/main/scripts/install-configuration.ps1 | iex
  • Manual Installation - The manual installation guide is designed for advanced users who want to manually install the profile. It's designed to be more flexible and customizable. It will also automatically install the required dependencies. You can follow the manual installation guide for more information.

Note

The automated installation script is the recommended installation method for most users. It's designed to be user-friendly and easy to use. It will automatically install the profile and configure the Windows Terminal. It will also automatically install the required dependencies.

🛠️ Usage


After installation, you can use the Windows Terminal as you normally would. The configuration changes should already be applied. Make sure to check out the wiki page for detailed information on each function. You can also use the help command to view the help documentation for each function. You can also alternatively use the Get-Help command to view the help documentation for each function. For example, to view the help documentation for the Write-Color function, you can use the following command:

Get-Help Write-Color

There are also a few functions that are designed to be used in the Windows Terminal. For example, the Restart-Shell function is designed to be used in the Windows Terminal. You can use the following command to restart your PowerShell session:

Restart-Shell

There's also the Update-Profile function, which is designed to be used in the Windows Terminal. You can use the following command to update your profile:

Update-Profile

Then we have the Manage-Profile function, which is designed to be used in the Windows Terminal. You can use the following command to manage your profile:

Manage-Profile

If you want to get more tips on how to use the Windows Terminal, you can use the following command:

Get-ShellTips

Note

The actual command is Get-ShellTips, but you can also use the alias tips to run the command. The tips are located in the tips.md file.

📚 Customization

The profile is designed to be customizable. You can customize the profile by using the profile command. This will open a new immersive window with a profile template. You can then use the available options to customize your profile. When you're done, simply restart your shell and the changes will be applied.

Note

The guide to customizing your profile can be found here.

🤝 Contributing


Contributions are welcome. Please fork this repository and create a pull request with your changes.

📝 License


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

📮 Contact


If you have any questions, feel free to reach out to me at [email protected].

🌟 Acknowledgements


  • luke-beep for creating this repository and maintaining it.

Profile