Skip to content

Commit ee958a6

Browse files
Add usage documentation for checking, updating, and uninstalling NerdFonts
1 parent a1c8850 commit ee958a6

1 file changed

Lines changed: 47 additions & 0 deletions

File tree

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,53 @@ This requires the shell to run in an elevated context (sudo or run as administra
5353
Install-NerdFont -All -Scope AllUsers
5454
```
5555

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

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

0 commit comments

Comments
 (0)