Skip to content

Commit 4d97edc

Browse files
📖 [Docs]: Font check, update, and uninstall workflows now documented (#67)
The README now documents the three most common post-install workflows that were previously undiscoverable: checking whether a NerdFont is installed, updating to the latest version, and uninstalling a font. These workflows use the [Fonts](https://psmodule.io/Fonts) module that is already installed automatically as a dependency. - Fixes #66 ## New: Check if a NerdFont is installed The README now includes examples showing how to use [`Get-Font`](https://psmodule.io/Fonts/Functions/Get-Font/) to query whether a specific NerdFont is installed, for both `CurrentUser` and `AllUsers` scopes. ## New: Update an installed NerdFont A new section explains that font files do not embed a NerdFonts release version, so there is no direct "outdated" check. The documented approach is to reinstall with `Install-NerdFont -Name '<font>' -Force` to ensure the latest version. ## New: Uninstall a NerdFont The README now shows how to use [`Uninstall-Font`](https://psmodule.io/Fonts/Functions/Uninstall-Font/) to remove NerdFonts, with examples for both user and system scopes. The section links to the Fonts module documentation and notes the dependency is installed automatically. ## Technical Details - Only `README.md` was changed — no code changes. - Three new subsections added under `## Usage`, following the established pattern of the existing install subsections. - Each section references the Fonts module dependency and links to the relevant command documentation at [psmodule.io/Fonts](https://psmodule.io/Fonts). - **Implementation plan progress**: All 4 tasks from issue #66 completed (check installed, update/reinstall, uninstall, dependency note).
1 parent a1c8850 commit 4d97edc

1 file changed

Lines changed: 56 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ Install-NerdFont -Name 'FiraCode' -Scope AllUsers #Tab completion works on Scope
4242
To install all NerdFonts on the system you can use the following command.
4343

4444
This will download and install all NerdFonts to the current user.
45+
4546
```powershell
4647
Install-NerdFont -All
4748
```
@@ -53,6 +54,61 @@ This requires the shell to run in an elevated context (sudo or run as administra
5354
Install-NerdFont -All -Scope AllUsers
5455
```
5556

57+
### Check if a NerdFont is installed
58+
59+
The [Fonts](https://psmodule.io/Fonts) module is installed automatically as a dependency and provides the
60+
[`Get-Font`](https://psmodule.io/Fonts/Functions/Get-Font/) command for querying installed fonts on the system.
61+
62+
To check if a specific NerdFont is installed for the current user:
63+
64+
```powershell
65+
Get-Font -Name 'FiraCode*'
66+
```
67+
68+
To check across all users on the system:
69+
70+
```powershell
71+
Get-Font -Name 'FiraCode*' -Scope AllUsers
72+
```
73+
74+
If the command returns results, the font is installed. If it returns nothing, the font is not installed in that scope.
75+
76+
### Update an installed NerdFont
77+
78+
Individual font files do not embed a NerdFonts release version, so there is no direct way to check whether an installed
79+
NerdFont is outdated. To ensure you have the version bundled with the module, reinstall the font using the `-Force` parameter:
80+
81+
```powershell
82+
Install-NerdFont -Name 'FiraCode' -Force
83+
```
84+
85+
If the font was originally installed for all users, update it with the matching scope (requires elevated privileges):
86+
87+
```powershell
88+
Install-NerdFont -Name 'FiraCode' -Force -Scope AllUsers
89+
```
90+
91+
This re-downloads and installs the font version bundled with your installed NerdFonts module, overwriting any existing
92+
files. To pick up newer font releases, update the NerdFonts module first (`Update-PSResource -Name NerdFonts` if you
93+
installed via PSResourceGet, or `Update-Module -Name NerdFonts` if you installed via PowerShellGet).
94+
95+
### Uninstall a NerdFont
96+
97+
To uninstall a NerdFont, use the [`Uninstall-Font`](https://psmodule.io/Fonts/Functions/Uninstall-Font/) command
98+
from the [Fonts](https://psmodule.io/Fonts) module (installed automatically as a dependency).
99+
100+
To uninstall a NerdFont from the current user:
101+
102+
```powershell
103+
Uninstall-Font -Name 'FiraCode*' # Tab completion works on name
104+
```
105+
106+
To uninstall a NerdFont for all users (requires elevated privileges):
107+
108+
```powershell
109+
Uninstall-Font -Name 'FiraCode*' -Scope AllUsers
110+
```
111+
56112
## Contributing
57113

58114
Coder or not, you can contribute to the project! We welcome all contributions.

0 commit comments

Comments
 (0)