Skip to content

Find-TriliumNote

SYNOPSIS

Searches for TriliumNext notes by title, label, or other criteria.

SYNTAX

SYNTAX

Limit

Find-TriliumNote -Search <string> -Limit <long> -OrderBy <string> [-Label <string>] [-FastSearch]
 [-IncludeArchivedNotes] [-DebugOn] [-AncestorNoteId <string>] [-SkipCertCheck] [-WhatIf] [-Confirm]
 [<CommonParameters>]

default

Find-TriliumNote -Search <string> [-Label <string>] [-FastSearch] [-IncludeArchivedNotes] [-DebugOn]
 [-AncestorNoteId <string>] [-SkipCertCheck] [-WhatIf] [-Confirm] [<CommonParameters>]

ALIASES

None

DESCRIPTION

Searches for notes in TriliumNext using a search term and optional filters such as label, ancestor note, fast search, archived notes, debug mode, result limit, and sort order. Requires authentication via Connect-TriliumAuth.

EXAMPLES

EXAMPLE 1

Find-TriliumNote -Search "meeting notes"

Searches for notes with the term "meeting notes".

EXAMPLE 2

Find-TriliumNote -Search "project" -Label "work" -FastSearch -IncludeArchivedNotes

Searches for notes with the term "project" and label "work", using fast search and including archived notes.

EXAMPLE 3

Find-TriliumNote -Search "api" -Limit 5 -OrderBy dateCreated

Searches for notes with the term "api", limits results to 5, and orders by creation date.

PARAMETERS

-AncestorNoteId

An optional note ID to search within.

Required?                    false
Position?                    5
Default value                None
Accept pipeline input?       false
Accept wildcard characters?  false
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- cf
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-DebugOn

Option to enable debug mode.

Required?                    false
Position?                    4
Default value                None
Accept pipeline input?       false
Accept wildcard characters?  false
Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-FastSearch

Option to enable fast search.

Required?                    false
Position?                    2
Default value                None
Accept pipeline input?       false
Accept wildcard characters?  false
Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-IncludeArchivedNotes

Option to include archived notes in the search results.

Required?                    false
Position?                    3
Default value                None
Accept pipeline input?       false
Accept wildcard characters?  false
Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Label

An optional label to filter the search results.

Required?                    false
Position?                    1
Default value                None
Accept pipeline input?       false
Accept wildcard characters?  false
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Limit

Limit the number of search results.

Required?                    false
Position?                    6
Default value                10
Accept pipeline input?       false
Accept wildcard characters?  false
Type: System.Int64
DefaultValue: 0
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Limit
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-OrderBy

The field to order the search results by.

Required?                    true
Position?                    7
Default value                None
Accept pipeline input?       false
Accept wildcard characters?  false
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Limit
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

The search term to find the note.

Required?                    true
Position?                    0
Default value                None
Accept pipeline input?       false
Accept wildcard characters?  false
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Limit
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: default
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-SkipCertCheck

Option to skip certificate check.

Required?                    false
Position?                    Named
Default value                None
Accept pipeline input?       false
Accept wildcard characters?  false
Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-WhatIf

Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- wi
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Object[]

Returns an array of note objects matching the search criteria.

NOTES

Note

Requires authentication via Connect-TriliumAuth.