https://github.com/krymtkts/pocof
An interactive pipeline filtering Cmdlet for PowerShell written in F#.
https://github.com/krymtkts/pocof
fsharp interactive pipeline powershell powershell-module
Last synced: 5 months ago
JSON representation
An interactive pipeline filtering Cmdlet for PowerShell written in F#.
- Host: GitHub
- URL: https://github.com/krymtkts/pocof
- Owner: krymtkts
- License: mit
- Created: 2022-04-24T05:21:43.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-15T06:31:48.000Z (over 1 year ago)
- Last Synced: 2024-09-15T09:59:53.437Z (over 1 year ago)
- Topics: fsharp, interactive, pipeline, powershell, powershell-module
- Language: F#
- Homepage:
- Size: 1.11 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pocof
[](https://www.powershellgallery.com/packages/pocof)
[](https://www.powershellgallery.com/packages/pocof)
[](https://codecov.io/gh/krymtkts/pocof)
[](https://opensource.org/licenses/MIT)
An interactive pipeline filtering Cmdlet for PowerShell written in F#.
Pocof implemented in .Net Standard 2.0, ensuring compatibility across Windows, Linux, and Mac.
A fork of [poco](https://github.com/jasonmarcher/poco) by jasonmarcher.
poco based on [powershell peco](https://gist.github.com/yumura/8df37c22ae1b7942dec7) by yumura.
powershell peco is a port of [peco](https://github.com/peco/peco) for PowerShell.
## Installation
[PowerShell Gallery | pocof](https://www.powershellgallery.com/packages/pocof/)
```powershell
# PowerShellGet 2.x
Install-Module -Name pocof -AllowPrerelease
# PSResourceGet (also known as PowerShellGet 3.0)
Install-PSResource -Name pocof -Prerelease
```
## Motivation
To learn how to write Cmdlet in F#.
Also to add my own flavor to poco which I often use.
## Cmdlet help
See [`Select-Pocof.md`](./docs/pocof/Select-Pocof.md)
## Disclaimer
- Some features are not implemented yet. I have created issues for these planned features.
- Some objects cannot filter like PowerShell.
- I mainly use Windows. I tested pocof in Linux on Ubuntu on WSL. I have not tested Mac as I do not have a Mac machine. If you encounter any bugs depends on Linux or Mac, please create an issue with details.
- The help for some parameters output raw Markdown because PlatyPS cannot render table and bullet list to MAML.
- PowerShell ISE is not supported.
## Publishing module
Build and publish to PowerShell Gallery.
To avoid accidents, dry runs mode is default.
```powershell
# DryRun.
Invoke-psake -taskList Release -parameters @{'Stage'='Release'}
# Publish.
Invoke-psake -taskList Release -parameters @{'Stage'='Release';'DryRun'=$false}
```
Recommended to do these in new PowerShell process.
After you import pocof, cannot release `FSharp.Core.dll` even if you invoke `Remove-Module`.