Skip to content
This repository has been archived by the owner on Apr 13, 2023. It is now read-only.

Get JournalIndex

Nick Spreitzer edited this page Feb 17, 2020 · 11 revisions
external help file: JournalCli.dll-Help.xml
Module Name: JournalCli
online version:
schema: 2.0.0

Get-JournalIndex

SYNOPSIS

Indexes your journal by tag.

Alias: gji

SYNTAX

Get-JournalIndex [-OrderBy <String>] [-Direction <String>] [-IncludeBodies] [-From <DateTime>] [-To <DateTime>]
 [-Location <String>] [<CommonParameters>]

DESCRIPTION

Dynamically generates an index of all journal entries by tag. Use this to see which tags have been used, how often they have been used, and which journal entries contain specific tags.

EXAMPLES

Example 1

PS C:\> Get-JournalIndex

Tag          Count Entries
---          ----- -------
work           120 {2018.01.08, 2018.01.09, 2018.01.10, 2018.01.11…}
vacation        42 {2018.01.26, 2018.01.27, 2018.01.28, 2018.01.29…}
family          36 {2018.01.13, 2018.02.21, 2018.02.24, 2018.02.26…}
relaxing        33 {2018.01.06, 2018.01.07, 2018.01.11, 2018.01.13…}
big-event       32 {2018.01.16, 2018.01.25, 2018.03.02, 2018.04.13…}
coding          28 {2018.02.22, 2018.02.26, 2018.03.03, 2018.03.04…}
work-drama      20 {2018.01.24, 2018.03.15, 2018.04.13, 2018.04.14…}

A truncated view of a journal index.

PARAMETERS

-Direction

The sort order.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Ascending, Descending

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

-From

Filters the index to journal entries that were written on or after the specified date.

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-IncludeBodies

Includes the full text content of each returned journal entry.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Location

The root directory for the journal to search for entries. This is only required if no default journal location has been set, or to search a non-default location.

Type: String
Parameter Sets: (All)
Aliases:

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

-OrderBy

The sort field.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Count, Name

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

-To

Filters the index to journal entries that were written on or before the specified date.

Type: DateTime
Parameter Sets: (All)
Aliases:

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

CommonParameters

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

INPUTS

None

OUTPUTS

JournalCli.Core.JournalIndex<>

NOTES

RELATED LINKS