Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nightroman/fardescription
Far Manager style descriptions of files and directories
https://github.com/nightroman/fardescription
module powershell
Last synced: 29 days ago
JSON representation
Far Manager style descriptions of files and directories
- Host: GitHub
- URL: https://github.com/nightroman/fardescription
- Owner: nightroman
- License: apache-2.0
- Created: 2020-05-19T15:27:39.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-07-10T12:07:30.000Z (over 2 years ago)
- Last Synced: 2024-10-30T12:13:26.272Z (3 months ago)
- Topics: module, powershell
- Language: C#
- Homepage:
- Size: 18.6 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FarDescription
Far Manager style descriptions of files and directories
***
FarDescription is the PowerShell module for managing file and directory
descriptions stored in special files.
## Quick start
**Step 1:** Get and install
FarDescription is published as the [PSGallery module](https://www.powershellgallery.com/packages/FarDescription).
You can install the module by this command:
```powershell
Install-Module FarDescription
```
**Step 2:** In a PowerShell command prompt import the module:
```powershell
Import-Module FarDescription
```
**Step 3:** Take a look at help for available commands and features:
```powershell
help about_FarDescription
Get-Command -Module FarDescription
help Update-FarDescription -Full
```
## Examples
Show items with descriptions:
```powershell
Import-Module FarDescription
Get-ChildItem | Format-Table Name, FarDescription
```
Get file description:
```powershell
Import-Module FarDescription
(Get-Item MyFile.txt).FarDescription
```
Set file description:
```powershell
Import-Module FarDescription
(Get-Item MyFile.txt).FarDescription = 'My description ...'
```
## See also
- [FarDescription Release Notes](https://github.com/nightroman/FarDescription/blob/master/Release-Notes.md)
- [about_FarDescription.help.txt](https://github.com/nightroman/FarDescription/blob/master/Module/en-US/about_FarDescription.help.txt)