Skip to content

๐Ÿš€ Welcome to my comprehensive repository dedicated to my Windows Terminal ๐Ÿ–ฅ๏ธ configuration. This repository serves as a showcase of my personalized terminal setup, featuring a range of customizations and configurations that enhance my development workflow.

License

Notifications You must be signed in to change notification settings

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.

๐ŸŒŸ Features


  • Nord Theme Integration - Utilizes Nord theme color variables for a beautiful interface.
  • Global Variables - Includes $ShellIcon, $ShellType, and more for enhanced scripting.
  • Restart-Shell Function - Easily restart your PowerShell session.
  • Timestamped Logging - Functions for detailed, timestamped logs.
  • Write-Color Function - Enrich your console with colored text.
  • Update-Profile Function - Keep your profile updated with the latest features.
  • Custom Functions and Variables Management - Import, manage, and preview custom scripts.
  • Interactive GUI Management - User-friendly GUI for managing functions and variables.
  • Automated Tool Installation - Scripted setup for Scoop, Chocolatey, oh-my-posh, and more.
  • Profile Settings GUI - Customize your profile settings with an interactive interface.
  • Registry Key Management - Centralized configuration management via Windows Registry.
  • Customizable Login Message - Personalize your PowerShell greeting message.
  • Error Handling Mechanisms - Advanced functions for error tracking and logging.
  • Nerd Fonts and Sysinternals Setup - Enhanced visual appeal with Nerd Fonts and Sysinternals tools integration.
  • Cross-Shell - Works with both PowerShell and Pwsh (PowerShell Core).
  • Interactive Function and Variable Preview - Easily view available functions and variables.
  • PowerShell Version Check - $ShellType variable to distinguish between PowerShell versions.
  • Automatic Update Checks - Option to enable automatic updates for the profile.
  • Manage-Profile Function - Centralized management for the entire profile.
  • Custom Script Incorporation - Easily add and manage your own scripts.
  • Help and Documentation - Access to detailed help and documentation for each function.
  • Guided Initial Setup - Initial setup with guided instructions and configuration checks.
  • Unix-Style Commands - Unix-style commands for enhanced cross-platform compatibility. Note that these commands are only imitations of the real commands. They are not actual Unix commands and won't function the same way.
  • Tips for Terminal usage - Tips for using the Windows Terminal.
  • Profile customization - Customize your profile using the following guide here.

This profile is designed to offer a comprehensive, customizable, and user-friendly PowerShell environment.

๐Ÿ› ๏ธ 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 lukehjo@duck.com.

๐ŸŒŸ Acknowledgements


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

Profile


About

๐Ÿš€ Welcome to my comprehensive repository dedicated to my Windows Terminal ๐Ÿ–ฅ๏ธ configuration. This repository serves as a showcase of my personalized terminal setup, featuring a range of customizations and configurations that enhance my development workflow.

Topics

Resources

License

Stars

Watchers

Forks