Invoke-PsFzfRipgrep.md

external help file	schema
PSFzf.psm1-help.xml	2.0.0

Invoke-PsFzfRipgrep

SYNOPSIS

Uses fzf as an interactive Ripgrep launcher

SYNTAX

Invoke-PsFzfRipgrep -SearchString <string> [-NoEditor]

DESCRIPTION

Uses Ripgrep and Fzf to interactively search files.

EXAMPLES

Launch Invoke-PsFzfRipgrep with search string

Invoke-PsFzfRipgrep -SearchString 'Key' # Starts search with initial ripgrep query of the string 'Key'

PARAMETERS

-SearchString

Initial string to start ripgrep query

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NoEditor

Returns result instead of launching editor

Type: Switch
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet does not support common parameters.

INPUTS

None

This cmdlet does not accept any input.

OUTPUTS

None

This cmdlet does not generate any output.

NOTES

This function is adapted from Fzf's advanced document. This function requires the installation of ripgrep and bat.

RELATED LINKS