{"id":14063486,"url":"https://github.com/luke-beep/shell-config","last_synced_at":"2025-07-09T05:32:39.147Z","repository":{"id":214242703,"uuid":"736028380","full_name":"luke-beep/shell-config","owner":"luke-beep","description":"🚀 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.","archived":false,"fork":false,"pushed_at":"2024-08-26T20:28:06.000Z","size":12702,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-08-26T23:37:24.710Z","etag":null,"topics":["bash","batch","clink","cmd","config","configuration","lua","ohmyposh","powershell","pwsh","shell"],"latest_commit_sha":null,"homepage":"https://github.com/luke-beep","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/luke-beep.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-26T19:23:25.000Z","updated_at":"2024-08-26T20:28:09.000Z","dependencies_parsed_at":"2024-06-21T04:57:40.421Z","dependency_job_id":"457703d6-709d-4008-9ec5-d5180244a1e8","html_url":"https://github.com/luke-beep/shell-config","commit_stats":null,"previous_names":["luke-beep/shell-config"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luke-beep%2Fshell-config","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luke-beep%2Fshell-config/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luke-beep%2Fshell-config/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luke-beep%2Fshell-config/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/luke-beep","download_url":"https://codeload.github.com/luke-beep/shell-config/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225489459,"owners_count":17482378,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash","batch","clink","cmd","config","configuration","lua","ohmyposh","powershell","pwsh","shell"],"created_at":"2024-08-13T07:03:21.821Z","updated_at":"2025-07-09T05:32:39.121Z","avatar_url":"https://github.com/luke-beep.png","language":"PowerShell","funding_links":[],"categories":["Unofficial Ports","PowerShell"],"sub_categories":["Aurora"],"readme":"\u003cdiv align=\"center\"\u003e\n\n# 🐚 Shell-Config\n\n![License](https://img.shields.io/badge/license-MIT-blue.svg)\n![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)\n![GitHub last commit](https://img.shields.io/github/last-commit/luke-beep/shell-config)\n![GitHub stars](https://img.shields.io/github/stars/luke-beep/shell-config)\n![GitHub forks](https://img.shields.io/github/forks/luke-beep/shell-config)\n\n\u003c/div\u003e\n\n### 🗂️ Table of Contents\n\n---\n\u003c!-- no toc --\u003e\n- [🐚 Shell-Config](#-shell-config)\n    - [🗂️ Table of Contents](#️-table-of-contents)\n    - [📚 Description](#-description)\n    - [📸 Screenshots](#-screenshots)\n    - [🚀 Installation](#-installation)\n    - [🛠️ Usage](#️-usage)\n    - [📚 Customization](#-customization)\n    - [🤝 Contributing](#-contributing)\n    - [📝 License](#-license)\n    - [📮 Contact](#-contact)\n    - [🌟 Acknowledgements](#-acknowledgements)\n\n### 📚 Description\n\n---\n\nThis repository contains my personal configuration for the Windows Terminal. It's designed to optimize my workflow and make terminal operations more efficient.\n\n\u003e [!NOTE]\n\u003e This shell configuration is designed and optimized for Windows 11. It may not work as intended on other versions of Windows.\n\n### 📸 Screenshots\n\n---\n\n![Screenshot](/assets/Product1.png)\n![Screenshot](/assets/Product2.png)\n\n### 🚀 Installation\n\n---\n\nYou 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).\n\n- **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:\n\n```powershell\nSet-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser\niwr -useb https://raw.githubusercontent.com/luke-beep/shell-config/main/scripts/install-configuration.ps1 | iex\n```\n\n- **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. \n\n\u003e [!NOTE]\n\u003e 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.\n\n### 🛠️ Usage\n\n---\n\nAfter 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:\n\n```powershell\nGet-Help Write-Color\n```\n\nThere 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:\n\n```powershell\nRestart-Shell\n```\n\nThere'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:\n\n```powershell\nUpdate-Profile\n```\n\nThen 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:\n\n```powershell\nManage-Profile\n```\n\nIf you want to get more tips on how to use the Windows Terminal, you can use the following command:\n\n```powershell\nGet-ShellTips\n```\n\n\u003e [!NOTE]\n\u003e 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.\n\n### 📚 Customization\n\nThe 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.\n\n\u003e [!NOTE]\n\u003e The guide to customizing your profile can be found [here](./docs/customizing.md).\n\n### 🤝 Contributing\n\n---\n\nContributions are welcome. Please fork this repository and create a pull request with your changes.\n\n### 📝 License\n\n---\n\nThis project is licensed under the MIT License. See [`LICENSE`](LICENSE) for more details.\n\n### 📮 Contact\n\n---\n\nIf you have any questions, feel free to reach out to me at [lukehjo@duck.com](mailto:lukehjo@duck.com).\n\n### 🌟 Acknowledgements\n\n---\n\n- [luke-beep](https://github.com/luke-beep) for creating this repository and maintaining it.\n\n---\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"assets/LukeHjo.png\" alt=\"Profile\" /\u003e\n\u003c/p\u003e\n\n---\n\n**\u003cdiv align=\"center\" id=\"footer\"\u003e© 2023 LukeHjo. All rights reserved. \u003cdiv\u003e**\n\u003cbr\u003e\n\n\u003cdiv align=\"right\"\u003e\u003ca href=\"#\"\u003e(Back to top)\u003c/a\u003e\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluke-beep%2Fshell-config","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluke-beep%2Fshell-config","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluke-beep%2Fshell-config/lists"}