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

Open Journal

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

Open-Journal

SYNOPSIS

Opens the journal's location on disk using the default operating system file viewer.

Alias: oj

SYNTAX

Open-Journal [-To <String>] [-Date <DateTime>] [-Location <String>] [<CommonParameters>]

DESCRIPTION

Opens the journal's location on disk using the default operating system file viewer, and navigates to the specified subdirectory. By default, it will open to the current month directory. Use the -To parameter to navigate to a different location, such as the current year or the journal's root directory.

EXAMPLES

Example 1

PS C:\> Open-Journal

Opens the journal and navigates to the current month directory.

Example 2

PS C:\> Open-Journal -To CurrentYear

Opens the journal and navigates to the current year directory.

PARAMETERS

-Date

A specific date for which to open a new journal entry. You can use a string representation of a date, such as '2019.12.20', or create a date using, for example,Get-Date -Day 10 which replaces the Day element from current date with 10. If today is January 22, 2020, Get-Date -Day 10 would return January 10, 2020.

Type: DateTime
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

-To

Specifies the location in the journal's file structure. The default is CurrentMonth.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: CurrentMonth, CurrentYear, Root

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

System.Object

NOTES

RELATED LINKS