{"id":13405476,"url":"https://github.com/devblackops/Terminal-Icons","last_synced_at":"2025-03-14T10:30:41.487Z","repository":{"id":37911219,"uuid":"179889555","full_name":"devblackops/Terminal-Icons","owner":"devblackops","description":"A PowerShell module to show file and folder icons in the terminal","archived":false,"fork":false,"pushed_at":"2024-08-06T15:47:02.000Z","size":982,"stargazers_count":2449,"open_issues_count":52,"forks_count":107,"subscribers_count":27,"default_branch":"main","last_synced_at":"2024-10-18T15:22:53.034Z","etag":null,"topics":["console","icon","icons","powershell","terminal"],"latest_commit_sha":null,"homepage":"","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/devblackops.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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},"funding":{"github":"devblackops","patreon":"devblackops"}},"created_at":"2019-04-06T21:39:51.000Z","updated_at":"2024-10-17T22:31:12.000Z","dependencies_parsed_at":"2022-07-09T17:18:00.695Z","dependency_job_id":"c3e015d5-8e3e-4e30-b755-24f97838b430","html_url":"https://github.com/devblackops/Terminal-Icons","commit_stats":{"total_commits":217,"total_committers":23,"mean_commits":9.434782608695652,"dds":"0.18894009216589858","last_synced_commit":"46866e45a602566bb8a52af5a04dac1d69482c29"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devblackops%2FTerminal-Icons","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devblackops%2FTerminal-Icons/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devblackops%2FTerminal-Icons/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devblackops%2FTerminal-Icons/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devblackops","download_url":"https://codeload.github.com/devblackops/Terminal-Icons/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221458044,"owners_count":16825265,"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":["console","icon","icons","powershell","terminal"],"created_at":"2024-07-30T19:02:03.290Z","updated_at":"2024-10-25T20:30:16.046Z","avatar_url":"https://github.com/devblackops.png","language":"PowerShell","funding_links":["https://github.com/sponsors/devblackops","https://patreon.com/devblackops"],"categories":["PowerShell","📚 UI","파워쉘을 사용하면서 사용하기 좋은 모듈들.","UI"],"sub_categories":["사용방법"],"readme":"# Terminal-Icons\n\nA PowerShell module to show file and folder icons in the terminal.\n\n| GitHub Actions | PSGallery | License |\n|----------------|-----------|---------|\n[![GitHub Actions Status][github-actions-badge]][github-actions-build] | [![PowerShell Gallery][psgallery-badge]][psgallery] | [![License][license-badge]][license]\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"./media/icon_256.png\" alt=\"Icon\"\u003e\n\u003c/p\u003e\n\n## Overview\n\n*Terminal-Icons* is a PowerShell module that adds file and folder icons when displaying items in the terminal.\nThis relies on the custom fonts provided by [Nerd Fonts](https://github.com/ryanoasis/nerd-fonts).\n\n\u003e You must be using one of the fonts provided by Nerd Fonts for this module to work as these fonts include tons of custom glyphs/icons that are referenced by their unicode number.\n\n## How Does this Work?\n\nIt uses a custom [format.ps1xml](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_format.ps1xml?view=powershell-6) file that inspects the items being displayed and looks up their appropriate icon based on name or extension.\nIcons for well-known files/folders are attempted to be used first before displaying an icon based on the file extension.\nAny files/folders that are not matched are shown using a generic file or folder icon.\n\n## Installation\n\nTo install the module from the [PowerShell Gallery](https://www.powershellgallery.com/):\n\n```powershell\nInstall-Module -Name Terminal-Icons -Repository PSGallery\n```\n\nYou can also install it from [Scoop](https://scoop.sh/):\n```powershell\nscoop bucket add extras\nscoop install terminal-icons\n```\n\n## Usage\n\n```powershell\nImport-Module -Name Terminal-Icons\n\nGet-Item ./README.md\n\nGet-ChildItem\n\nGet-ChildItem | Format-List\n\nGet-ChildItem | Format-Wide\n```\n\n## Commands\n\n| Command | Description\n|---------|-------------|\nAdd-TerminalIconsColorTheme | Add a Terminal-Icons color theme for the current user.\nAdd-TerminalIconsIconTheme  | Add a Terminal-Icons icon theme for the current user.\nFormat-TerminalIcons        | Prepend a custom icon (with color) to the provided file or folder object when displayed.\nGet-TerminalIconsColorTheme | List the available color themes.\nGet-TerminalIconsIconTheme  | List the available icon themes.\nGet-TerminalIconsTheme      | Get the currently applied color and icon theme.\nRemove-TerminalIconsTheme   | Removes a given icon or color theme.\nSet-TerminalIconsColorTheme | **DEPRECATED** Set the Terminal-Icons color theme.\nSet-TerminalIconsIconTheme  | **DEPRECATED** Set the Terminal-Icons icon theme.\nSet-TerminalIconsTheme      | Set the Terminal-Icons icon and/or color theme.\nShow-TerminalIconsTheme     | List example directories and files to show the currently applied color and icon themes.\n\n## Screenshots\n\n```powershell\nGet-ChildItem -Path . -Force\n```\n\n![Screenshot 1](./media/screenshot.png)\n\n## Tips\n\nIf using the default console in Windows and not something like VSCode, ConEmu, Terminus, etc., you may have issues getting a nerd font to be recognized correctly.\nTry following this [quick guide](https://gist.github.com/markwragg/6301bfcd56ce86c3de2bd7e2f09a8839) by [Mark Wragg](https://twitter.com/markwragg).\n[Issue #269](https://github.com/ryanoasis/nerd-fonts/issues/269) on Nerd Fonts has more information.\n\n## Contributions\n\nAny ideas on how to improve this module are welcome.\nIf you have ideas for an appropriate [glyph](http://nerdfonts.com/#cheat-sheet) to display for a well-known folder or file, or a particular file extension, please raise an [issue](https://github.com/devblackops/Terminal-Icons/issues/new).\nIf you'd like to submit an entirely new color or icon theme, take a look at the existing ones [here](https://github.com/devblackops/Terminal-Icons/tree/master/Terminal-Icons/Data/colorThemes) and [here](https://github.com/devblackops/Terminal-Icons/tree/master/Terminal-Icons/Data/iconThemes), create your new file(s) named what ever you like, and submit a pull request.\n\n[github-actions-badge]: https://github.com/devblackops/Terminal-Icons/workflows/CI/badge.svg\n[github-actions-build]: https://github.com/devblackops/Terminal-Icons/actions\n[psgallery-badge]:      https://img.shields.io/powershellgallery/dt/terminal-icons.svg\n[psgallery]:            https://www.powershellgallery.com/packages/terminal-icons\n[license-badge]:        https://img.shields.io/github/license/poshbotio/poshbot.svg\n[license]:              https://www.powershellgallery.com/packages/poshbot\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevblackops%2FTerminal-Icons","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevblackops%2FTerminal-Icons","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevblackops%2FTerminal-Icons/lists"}