├── LICENSE
├── README.md
├── assets
├── Azrael.ico
├── LukeHjo.png
├── Product1.png
└── Product2.png
├── common
├── Shared
│ ├── generate-shared.ps1
│ └── shared_files.json
├── SysWOW64
│ ├── common_cpl.txt
│ ├── common_dll.txt
│ ├── common_exe.txt
│ ├── common_msc.txt
│ └── generate-common.ps1
├── System32
│ ├── common_cpl.txt
│ ├── common_dll.txt
│ ├── common_exe.txt
│ ├── common_msc.txt
│ └── generate-common.ps1
└── Windows
│ ├── common_cpl.txt
│ ├── common_dll.txt
│ ├── common_exe.txt
│ ├── common_msc.txt
│ └── generate-common.ps1
├── configs
├── clink
│ ├── oh-my-posh.lua
│ └── starship.lua
├── neovim
│ └── README.md
├── omp
│ └── theme.json
├── pwsh
│ ├── Microsoft.PowerShell_profile.ps1
│ ├── custom-functions.ps1
│ ├── custom-variables.ps1
│ ├── new-aliases.json
│ ├── old-aliases.json
│ ├── random-tips.txt
│ ├── tips.md
│ └── version
├── scoop
│ └── scoop-hook.ps1
├── terminal
│ └── settings.json
├── winget
│ ├── completion.ps1
│ └── settings.json
└── zoxide
│ └── zoxide-hook.ps1
├── docs
├── customizing.md
└── installation.md
└── scripts
├── install-configuration.ps1
├── packages
├── install-packages.ps1
└── packages.md
└── useful-commands.ps1
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2023 Azrael (LukeHjo)
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # 🐚 Shell-Config
4 |
5 | 
6 | 
7 | 
8 | 
9 | 
10 |
11 |
12 |
13 | ### 🗂️ Table of Contents
14 |
15 | ---
16 |
17 | - [🐚 Shell-Config](#-shell-config)
18 | - [🗂️ Table of Contents](#️-table-of-contents)
19 | - [📚 Description](#-description)
20 | - [📸 Screenshots](#-screenshots)
21 | - [🚀 Installation](#-installation)
22 | - [🛠️ Usage](#️-usage)
23 | - [📚 Customization](#-customization)
24 | - [🤝 Contributing](#-contributing)
25 | - [📝 License](#-license)
26 | - [📮 Contact](#-contact)
27 | - [🌟 Acknowledgements](#-acknowledgements)
28 |
29 | ### 📚 Description
30 |
31 | ---
32 |
33 | This repository contains my personal configuration for the Windows Terminal. It's designed to optimize my workflow and make terminal operations more efficient.
34 |
35 | > [!NOTE]
36 | > This shell configuration is designed and optimized for Windows 11. It may not work as intended on other versions of Windows.
37 |
38 | ### 📸 Screenshots
39 |
40 | ---
41 |
42 | 
43 | 
44 |
45 | ### 🚀 Installation
46 |
47 | ---
48 |
49 | 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).
50 |
51 | - **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:
52 |
53 | ```powershell
54 | Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
55 | iwr -useb https://raw.githubusercontent.com/luke-beep/shell-config/main/scripts/install-configuration.ps1 | iex
56 | ```
57 |
58 | - **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.
59 |
60 | > [!NOTE]
61 | > 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.
62 |
63 | ### 🛠️ Usage
64 |
65 | ---
66 |
67 | 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:
68 |
69 | ```powershell
70 | Get-Help Write-Color
71 | ```
72 |
73 | 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:
74 |
75 | ```powershell
76 | Restart-Shell
77 | ```
78 |
79 | 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:
80 |
81 | ```powershell
82 | Update-Profile
83 | ```
84 |
85 | 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:
86 |
87 | ```powershell
88 | Manage-Profile
89 | ```
90 |
91 | If you want to get more tips on how to use the Windows Terminal, you can use the following command:
92 |
93 | ```powershell
94 | Get-ShellTips
95 | ```
96 |
97 | > [!NOTE]
98 | > 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.
99 |
100 | ### 📚 Customization
101 |
102 | 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.
103 |
104 | > [!NOTE]
105 | > The guide to customizing your profile can be found [here](./docs/customizing.md).
106 |
107 | ### 🤝 Contributing
108 |
109 | ---
110 |
111 | Contributions are welcome. Please fork this repository and create a pull request with your changes.
112 |
113 | ### 📝 License
114 |
115 | ---
116 |
117 | This project is licensed under the MIT License. See [`LICENSE`](LICENSE) for more details.
118 |
119 | ### 📮 Contact
120 |
121 | ---
122 |
123 | If you have any questions, feel free to reach out to me at [lukehjo@duck.com](mailto:lukehjo@duck.com).
124 |
125 | ### 🌟 Acknowledgements
126 |
127 | ---
128 |
129 | - [luke-beep](https://github.com/luke-beep) for creating this repository and maintaining it.
130 |
131 | ---
132 |
133 |
134 | 
135 |
136 |
137 | ---
138 |
139 | **