https://github.com/luke-beep/shell-config
🚀 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.
https://github.com/luke-beep/shell-config
bash batch clink cmd config configuration lua ohmyposh powershell pwsh shell
Last synced: 3 months ago
JSON representation
🚀 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.
- Host: GitHub
- URL: https://github.com/luke-beep/shell-config
- Owner: luke-beep
- License: mit
- Created: 2023-12-26T19:23:25.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-26T20:28:06.000Z (about 1 year ago)
- Last Synced: 2024-08-26T23:37:24.710Z (about 1 year ago)
- Topics: bash, batch, clink, cmd, config, configuration, lua, ohmyposh, powershell, pwsh, shell
- Language: PowerShell
- Homepage: https://github.com/luke-beep
- Size: 12.1 MB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nord - Nord for Windows Shell
- awesome-nord - Nord for Windows Shell
- jimsghstars - luke-beep/shell-config - 🚀 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 (PowerShell)
README
# 🐚 Shell-Config
### 🗂️ Table of Contents
---
- [🐚 Shell-Config](#-shell-config)
- [🗂️ Table of Contents](#️-table-of-contents)
- [📚 Description](#-description)
- [📸 Screenshots](#-screenshots)
- [🚀 Installation](#-installation)
- [🛠️ Usage](#️-usage)
- [📚 Customization](#-customization)
- [🤝 Contributing](#-contributing)
- [📝 License](#-license)
- [📮 Contact](#-contact)
- [🌟 Acknowledgements](#-acknowledgements)
### 📚 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
---
### 🚀 Installation
---
You have two choices for installation. You can either use the automated installation script or manually install the profile. The [automated installation script](./scripts/install-configuration.ps1) is recommended for most users. However, if you want to manually install the profile, you can follow the [manual installation guide](./docs/installation.md).
- **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:
```powershell
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](./docs/installation.md) 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`](https://github.com/luke-beep/shell-config/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:
```powershell
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:
```powershell
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:
```powershell
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:
```powershell
Manage-Profile
```
If you want to get more tips on how to use the Windows Terminal, you can use the following command:
```powershell
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`](/configs/pwsh/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](./docs/customizing.md).
### 🤝 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`](LICENSE) for more details.
### 📮 Contact
---
If you have any questions, feel free to reach out to me at [lukehjo@duck.com](mailto:lukehjo@duck.com).
### 🌟 Acknowledgements
---
- [luke-beep](https://github.com/luke-beep) for creating this repository and maintaining it.
---
---
**
© 2023 LukeHjo. All rights reserved.