JournalCli.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-JournalEntryContent</command:name> <command:verb>Add</command:verb> <command:noun>JournalEntryContent</command:noun> <maml:description> <maml:para>Adds content to a journal entry, directly from the command line. Alias: `aje`</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use this cmdlet to write journal entries directly from the command line. If an entry does not exist for the target date, one will be created. If one does exist, the specified content will be appended. Content will be inserted under the date-based default H1 header, unless a custom header is provided using the `-Header` parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-JournalEntryContent</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Body</maml:name> <maml:Description> <maml:para>The content to add to the specified journal entry.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Tags</maml:name> <maml:Description> <maml:para>An array of tags used to filter the list of journal entries.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Date</maml:name> <maml:Description> <maml:para>If provided, the `Body` content will be appended to the journal entry for this date. If an entry does not yet exist, it will be created. The default date is today.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DateOffset</maml:name> <maml:Description> <maml:para>An integer representing the number of days to offset the journal entry date. The starting point is today, unless overridden by the `-Date` parameter. Use a negative number to offset backwards, and a positive number to offset forward.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Header</maml:name> <maml:Description> <maml:para>By default, body content is appended to the default date-based H1 header `journal-cli` automatically adds to all new journal entries. Use `-Header` to override this behavior and add new content under a specified header. If the header already exists, the content is appended to it. Otherwise, a new header is appended to the bottom of the entry. The header text must be preceded with 1 to 6 `#` characters, which indicates the header level. For example, `### Test!` will create an H3 header with the text "Test!".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Body</maml:name> <maml:Description> <maml:para>The content to add to the specified journal entry.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Date</maml:name> <maml:Description> <maml:para>If provided, the `Body` content will be appended to the journal entry for this date. If an entry does not yet exist, it will be created. The default date is today.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DateOffset</maml:name> <maml:Description> <maml:para>An integer representing the number of days to offset the journal entry date. The starting point is today, unless overridden by the `-Date` parameter. Use a negative number to offset backwards, and a positive number to offset forward.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Header</maml:name> <maml:Description> <maml:para>By default, body content is appended to the default date-based H1 header `journal-cli` automatically adds to all new journal entries. Use `-Header` to override this behavior and add new content under a specified header. If the header already exists, the content is appended to it. Otherwise, a new header is appended to the bottom of the entry. The header text must be preceded with 1 to 6 `#` characters, which indicates the header level. For example, `### Test!` will create an H3 header with the text "Test!".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Tags</maml:name> <maml:Description> <maml:para>An array of tags used to filter the list of journal entries.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Add-JournalEntryContent "I went to work today, and it was swell."</dev:code> <dev:remarks> <maml:para>Adds the specified text to today's journal entry. If an entry doesn't yet exist for today, one is created. The text is inserted under the default date-based H1 header that is automatically inserted by `journal-cli`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Add-JournalEntryContent "Ned and I discussed developing a new widget" -Tags 1:1 -Header "## 1:1 with Ned"</dev:code> <dev:remarks> <maml:para>Adds the specified text to today's journal entry. If an entry doesn't yet exist for today, one is created. The text is inserted under the custom H2 header `## 1:1 with Ned`. If the header doesn't already exist, it will be added. The tag `1:1` is also added, if it doesn't already exist.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Add-JournalEntryContent "- Wrote some code >> - Updated Jira >> - Caught up on email."</dev:code> <dev:remarks> <maml:para>Adds the specified multi-line text to today's journal entry. If an entry doesn't yet exist for today, one is created. The text is inserted under the default date-based H1 header that is automatically inserted by `journal-cli`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Add-JournalEntryContent "Someone made really weak coffee at the office today. Very disappointing", "On the other hand, lunch was catered today and it was really tasty." -Header "### Today" -Tags work</dev:code> <dev:remarks> <maml:para>Adds the specified multi-line text to today's journal entry, with each element of the array corresponding to a new paragraph. If an entry doesn't yet exist for today, one is created. The text is inserted under the custom H3 header `## Today`. If the header doesn't already exist, it will be added. The tag `work` is also added, if it doesn't already exist.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>PS C:\> Add-JournalEntryContent "Meeting with execs regarding move to AWS next year" -DateOffset -1</dev:code> <dev:remarks> <maml:para>Adds the specified text to yesterday's journal entry. If an entry doesn't yet exist for yesterday, one is created. The text is inserted under the default date-based H1 header that is automatically inserted by `journal-cli`.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Backup-Journal</command:name> <command:verb>Backup</command:verb> <command:noun>Journal</command:noun> <maml:description> <maml:para>Creates a complete backup of your journal entries. Alias: `bj`</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a zip archive, optionally password-protected, that includes all journal entry files and saves it to the specified location.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Backup-Journal</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackupLocation</maml:name> <maml:Description> <maml:para>The path to the directory where backup files should be saved. This parameters is required if a location has not previously been saved.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>The path to the root directory for the journal. This is required if it has not been previously saved using the `Set-DefaultJournalLocation` cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>The password to apply to the zip archive. If none is provided, the archive will not be password protected.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SaveParameters</maml:name> <maml:Description> <maml:para>Saves the specified password and/or location for future use.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackupLocation</maml:name> <maml:Description> <maml:para>The path to the directory where backup files should be saved. This parameters is required if a location has not previously been saved.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>The path to the root directory for the journal. This is required if it has not been previously saved using the `Set-DefaultJournalLocation` cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>The password to apply to the zip archive. If none is provided, the archive will not be password protected.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SaveParameters</maml:name> <maml:Description> <maml:para>Saves the specified password and/or location for future use.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Backup-Journal -BackupLocation 'C:\My\Secret\Location' -Password "secret123" -SaveParameters</dev:code> <dev:remarks> <maml:para>Backup your journal to the specified location with the provided password, and save the location and password values for future use. Saved values are encrypted locally on disk.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Backup-Journal</dev:code> <dev:remarks> <maml:para>Backup your journal using the previously saved location and password. Note that if a password and save location have not both been previously saved, the command will fail.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>ConvertTo-Yaml</command:name> <command:verb>ConvertTo</command:verb> <command:noun>Yaml</command:noun> <maml:description> <maml:para>Converts an object to a Yaml-formatted string. Alias: `cty`</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Serializes any object into a Yaml-formatted string. This is also useful for making a complex object with nested properties human readable when printed to the screen.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>ConvertTo-Yaml</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>The object to serialize into yaml.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>The object to serialize into yaml.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-JournalEntriesByTag -Location J:\ -Tags dads-visit | ConvertTo-Yaml #### Result #### Tag: dads-visit Count: 1 Entries: - FilePath: J:\2019\05 May\2019.05.09.md Tags: - dads-visit Headers: - '# Thursday, May 9, 2019' - '# Friday May 10, 2019' - '# Saturday May 11, 2019' - '# Sunday May 12, 2019' - '# Monday May 13, 2019' - '# Tuesday May 14, 2019'</dev:code> <dev:remarks> <maml:para>Get all entries that are tagged `dads-visit` and display the results as yaml. Yaml is an easy to read format which works well for displaying text in a terminal window.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-JournalDefaultLocation</command:name> <command:verb>Get</command:verb> <command:noun>JournalDefaultLocation</command:noun> <maml:description> <maml:para>Returns the journal's saved default location on disk, if one exists.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the default journal location, if one has previously been saved using `Set-DefaultJournalLocation`.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-JournalDefaultLocation</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-JournalDefaultLocation</dev:code> <dev:remarks> <maml:para>Gets the default location, if one has been saved. Otherwise, returns nothing.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-JournalEntriesByTag</command:name> <command:verb>Get</command:verb> <command:noun>JournalEntriesByTag</command:noun> <maml:description> <maml:para>Returns a journal index consisting only of entries that contain specified tags and, optionally, falls within a specific date range. Alias: `gjt`</maml:para> </maml:description> </command:details> <maml:description> <maml:para>In contrast with `Get-JournalIndex` which returns an index of all entries, this cmdlet returns an index that only consists of entries containing specific tags and, optionally, filters out entries that were written outside a specific date range. By default, this cmdlet returns the headers from each included entry. The complete journal entry content is returned if the `IncludeBodies` switch is used. See the recipes page (https://journalcli.me/docs/recipes)for examples of paginating through the full text content of each entry.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-JournalEntriesByTag</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>Filters included journal entries to those which include all specified tags.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>From</maml:name> <maml:Description> <maml:para>Filters included journal entries to those which were written on or after the specified date.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeBodies</maml:name> <maml:Description> <maml:para>Includes the full text content of each returned journal entry.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>The root directory for the journal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:Description> <maml:para>An array of tags used to filter the list of journal entries.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>To</maml:name> <maml:Description> <maml:para>Filters included journal entries to those which were written on or before the specified date.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>Filters included journal entries to those which include all specified tags.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>From</maml:name> <maml:Description> <maml:para>Filters included journal entries to those which were written on or after the specified date.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeBodies</maml:name> <maml:Description> <maml:para>Includes the full text content of each returned journal entry.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>The root directory for the journal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:Description> <maml:para>An array of tags used to filter the list of journal entries.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>To</maml:name> <maml:Description> <maml:para>Filters included journal entries to those which were written on or before the specified date.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>`JournalIndex<IJournalEntry>`</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>> Get-JournalEntriesByTag -Tags work,vacation Tag Count Entries --- ----- ------- work 141 {2018.01.08, 2018.01.09, 2018.01.10, 2018.01.11…} vacation 1 {2019.10.11}</dev:code> <dev:remarks> <maml:para>Returns all journal entries that are tagged either `work` or `vacation`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>> Get-JournalEntriesByTag -Tags work,vacation -All Tag Count Entries --- ----- ------- big-event 1 {2019.10.11} coding 1 {2019.10.11} work 1 {2019.10.11} vacation 1 {2019.10.11}</dev:code> <dev:remarks> <maml:para>Returns all journal entries that are tagged both `work` and `vacation`. In this example, there is only one matching entry, but the results are still indexed by tag which is why 4 results are listed - one for each tag contained in that entry.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>> Get-JournalEntriesByTag -Tags work,vacation -All | select entries | unique Entries ------- {2019.10.11}</dev:code> <dev:remarks> <maml:para>Building on Example 2, this filters the results to only unique entries.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>> Get-JournalEntriesByTag -Tags work -From '2019.1.1' -To '2019.6.7'</dev:code> <dev:remarks> <maml:para>Returns all journal entries that are tagged `work` and were written between January 1st 2019 and June 7th 2019.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-JournalFiles</command:name> <command:verb>Get</command:verb> <command:noun>JournalFiles</command:noun> <maml:description> <maml:para>Returns journal entries as `file` objects, which enables text searching via the `Select-String` cmdlet.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The primary purpose of this cmdlet is to enable text searching via PowerShell's `Select-String` (https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/select-string?view=powershell-6)cmdlet, which operates best when provided file objects. Use this cmdlet to retrieve a subset of journal entries, filtered by date and/or tags, and pipe the results into `Select-String` to get detailed information about where certain words or phrases can be found in your journal. Results include the entry file name, the matching line of text, and the line number where the text was found.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-JournalFiles</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>From</maml:name> <maml:Description> <maml:para>Limits returned journal entries to those created on or after the specified date.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:Description> <maml:para>An array of tags used to filter the list of journal entries.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>To</maml:name> <maml:Description> <maml:para>Limits returned journal entries to those created on or before the specified date. The default value is `Today`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>From</maml:name> <maml:Description> <maml:para>Limits returned journal entries to those created on or after the specified date.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:Description> <maml:para>An array of tags used to filter the list of journal entries.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>To</maml:name> <maml:Description> <maml:para>Limits returned journal entries to those created on or before the specified date. The default value is `Today`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-JournalFiles -Tags family | Select-String 'christmas dinner' | Format-Table -Property LineNumber,Line,FileName</dev:code> <dev:remarks> <maml:para>Finds all journal entries that are tagged `family`, searches them for the phrase `christmas dinner`, and displays the line of text, line number, and file name where the phrase was found in a tabular format.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-JournalFiles -From '2019.12.20' -To '2019.12.30' | Select-String 'canasta' | Format-Table -Property LineNumber,Line,FileName</dev:code> <dev:remarks> <maml:para>Finds all journal entries created between December 20th, 2019 and December 30th 2019, searches them for the phrase `canasta`, and displays the line of text, line number, and file name where the phrase was found in a tabular format.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-JournalIndex</command:name> <command:verb>Get</command:verb> <command:noun>JournalIndex</command:noun> <maml:description> <maml:para>Indexes your journal by tag. Alias: `gji`</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-JournalIndex</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Direction</maml:name> <maml:Description> <maml:para>The sort order.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Ascending</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Descending</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>From</maml:name> <maml:Description> <maml:para>Filters the index to journal entries that were written on or after the specified date.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeBodies</maml:name> <maml:Description> <maml:para>Includes the full text content of each returned journal entry.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>The sort field.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Count</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Name</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>To</maml:name> <maml:Description> <maml:para>Filters the index to journal entries that were written on or before the specified date.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Direction</maml:name> <maml:Description> <maml:para>The sort order.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>From</maml:name> <maml:Description> <maml:para>Filters the index to journal entries that were written on or after the specified date.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeBodies</maml:name> <maml:Description> <maml:para>Includes the full text content of each returned journal entry.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>The sort field.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>To</maml:name> <maml:Description> <maml:para>Filters the index to journal entries that were written on or before the specified date.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>`JournalCli.Core.JournalIndex<>`</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>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…}</dev:code> <dev:remarks> <maml:para>A truncated view of a journal index.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-JournalReadmeEntries</command:name> <command:verb>Get</command:verb> <command:noun>JournalReadmeEntries</command:noun> <maml:description> <maml:para>Lists readme entries which are due to be re-read.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves a list of all readme journal entries which are due to be re-read. More precisely, it returns entries that have a readme date on or before today . The list can be limited to entries which became due for re-reading within a certain range of time, such as over the last year or 18 months.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-JournalReadmeEntries</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>Returns all readme entries which have elapsed prior to today. This is the default and does not need to be explicitly provided.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-JournalReadmeEntries</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Duration</maml:name> <maml:Description> <maml:para>A number, greater than or equal to 1, which specifies the number of Periods to include in the results lists. This parameter can only be used in conjunction with `-Period`, documented below.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Period</maml:name> <maml:Description> <maml:para>Specifies a period of time - Years, Months or Days - used to filter the number of readme entries returned. This parameter can only be used in conjunction with `-Duration`, documented above.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Years</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Months</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Days</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>Returns all readme entries which have elapsed prior to today. This is the default and does not need to be explicitly provided.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Duration</maml:name> <maml:Description> <maml:para>A number, greater than or equal to 1, which specifies the number of Periods to include in the results lists. This parameter can only be used in conjunction with `-Period`, documented below.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Period</maml:name> <maml:Description> <maml:para>Specifies a period of time - Years, Months or Days - used to filter the number of readme entries returned. This parameter can only be used in conjunction with `-Duration`, documented above.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>JournalCli.Core.ReadmeJournalEntryCollection</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>> Get-JournalReadmeEntries -Period Years -Duration 1 | Format-List ReadmeDate : Saturday, August 27, 2019 Headers : {## ReadMe:} EntryName : 2019.08.27 Tags : {work, exercise} ReadmeDate : Saturday, August 1, 2019 Headers : {## Car broke down, ## The evening} EntryName : 2019.08.23 Tags : {work, event, predictions} ReadmeDate : Sunday, January 26, 2019 Headers : {# Thursday, September 26, 2019} EntryName : 2019.09.26 Tags : {coding, work} # Notes: # 1. This example is contrived, so the entry dates and readme dates may appear a bit odd. # 2. Format-List is not required; It was used only for readability.</dev:code> <dev:remarks> <maml:para>Retrieves all readme entries which have elapsed over the past year.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-RecentJournalEntries</command:name> <command:verb>Get</command:verb> <command:noun>RecentJournalEntries</command:noun> <maml:description> <maml:para>This cmdlet is obsolete. Use `Get-JournalFiles` instead. Returns the file names for recent journal entries, ordered from most to least recent.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the file names for recent journal entries, ordered from most to least recent. By default, all entries names are returned. Use the `-Limit` parameter to only return a limited number of entries.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RecentJournalEntries</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>The number of entries to returns. If not specified, all entries are returned.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>The number of entries to returns. If not specified, all entries are returned.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-RecentJournalEntries</dev:code> <dev:remarks> <maml:para>Returns all journal entry file names, ordered from most to least recent.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-RecentJournalEntries -Limit 100</dev:code> <dev:remarks> <maml:para>Returns the 100 most recently journal entry file names, ordered from most to least recent.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-CompiledJournalEntry</command:name> <command:verb>New</command:verb> <command:noun>CompiledJournalEntry</command:noun> <maml:description> <maml:para>Aggregates a collection of journal entries into a new, individual journal entry.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Aggregates a collection of journal entries into a single compiled entry. The input entries can be filtered by tags, date range, or a custom query. The resulting compiled entry contains all the selected journal entries in a single document, laid out in sequential order based on the creation date of the input entries. This allows you to dynamically assembly new journal entries, composed of previous entries, so that they can be read in new and interesting ways.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-CompiledJournalEntry</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllTags</maml:name> <maml:Description> <maml:para>Requires that selected journal entries include all tags provided in the `-Tags` parameter. By default, entries are selected if they contain any of the tags specified by the `-Tags` parameter.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>From</maml:name> <maml:Description> <maml:para>Filters included journal entries to those which were written on or after the specified date.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:Description> <maml:para>An array of tags used to filter the collection of journal entries</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>To</maml:name> <maml:Description> <maml:para>Filters included journal entries to those which were written on or before the specified date.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-CompiledJournalEntry</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Entries</maml:name> <maml:Description> <maml:para>An array of `IJournalEntry` objects to be combined into a single journal entry. These objects can be generated using the `Get-journalIndex` or `Get-JournalEntriesByTag` cmdlets. See the examples for more information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllTags</maml:name> <maml:Description> <maml:para>Requires that selected journal entries include all tags provided in the `-Tags` parameter. By default, entries are selected if they contain any of the tags specified by the `-Tags` parameter.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Entries</maml:name> <maml:Description> <maml:para>An array of `IJournalEntry` objects to be combined into a single journal entry. These objects can be generated using the `Get-journalIndex` or `Get-JournalEntriesByTag` cmdlets. See the examples for more information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>From</maml:name> <maml:Description> <maml:para>Filters included journal entries to those which were written on or after the specified date.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:Description> <maml:para>An array of tags used to filter the collection of journal entries</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>To</maml:name> <maml:Description> <maml:para>Filters included journal entries to those which were written on or before the specified date.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-CompiledJournalEntry -Tags vacation,germany -AllTags</dev:code> <dev:remarks> <maml:para>Creates a new compiled entry based on all previous non-compiled entries which were tagged both `germany` and `vacation`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-CompiledJournalEntry -Tags big-event -From '2019.1.1'</dev:code> <dev:remarks> <maml:para>Creates a new compiled entry based on entries originally written between January 1, 2019 and today which were tagged`big-event`.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-JournalEntry</command:name> <command:verb>New</command:verb> <command:noun>JournalEntry</command:noun> <maml:description> <maml:para>Creates a new journal entry. Alias: `nj`</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new markdown-based journal entry with the provided tags and readme value, and opens it for writing using the default editor for `.md` files. If an entry already exists for the specified date, you will be prompted to open it for further editing. In this case, the provided tags and readme value are discarded.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-JournalEntry</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Date</maml:name> <maml:Description> <maml:para>A specific date for which to create 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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DateOffset</maml:name> <maml:Description> <maml:para>An integer representing the number of days to offset from today's date. For example, -1 represents yesterday. The default is 0, meaning today.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Readme</maml:name> <maml:Description> <maml:para>A date expressed as a string, or a duration of time from the date of the journal entry, when the journal entry should be re-read. Date Expressions Date expressions are parsed using .NET's DateTime.Parse() (https://docs.microsoft.com/en-us/dotnet/api/system.datetime.parse?view=netcore-3.0)method which can successfully handle any common culture-specific formats. Examples valid for United States English include:</maml:para> <maml:para>- 11/8/2019</maml:para> <maml:para>- 11/8/19</maml:para> <maml:para>- 11.8.2019</maml:para> <maml:para>- 11-8-2019</maml:para> <maml:para>- Friday November 8, 2019 Duration Expressions Valid durations are expressed as an integer, followed by a single space, followed by one of the following periods:</maml:para> <maml:para>- day(s)</maml:para> <maml:para>- week(s)</maml:para> <maml:para>- month(s)</maml:para> <maml:para>- year(s)</maml:para> <maml:para></maml:para> <maml:para>Valid examples include:</maml:para> <maml:para>- "1 year"</maml:para> <maml:para>- "36 weeks"</maml:para> <maml:para>- "1024 days"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:Description> <maml:para>An array of strings to apply to the entry as tags. Multiword tags should not have spaces. Instead, separate words by dashes or underscores.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Date</maml:name> <maml:Description> <maml:para>A specific date for which to create 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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DateOffset</maml:name> <maml:Description> <maml:para>An integer representing the number of days to offset from today's date. For example, -1 represents yesterday. The default is 0, meaning today.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Readme</maml:name> <maml:Description> <maml:para>A date expressed as a string, or a duration of time from the date of the journal entry, when the journal entry should be re-read. Date Expressions Date expressions are parsed using .NET's DateTime.Parse() (https://docs.microsoft.com/en-us/dotnet/api/system.datetime.parse?view=netcore-3.0)method which can successfully handle any common culture-specific formats. Examples valid for United States English include:</maml:para> <maml:para>- 11/8/2019</maml:para> <maml:para>- 11/8/19</maml:para> <maml:para>- 11.8.2019</maml:para> <maml:para>- 11-8-2019</maml:para> <maml:para>- Friday November 8, 2019 Duration Expressions Valid durations are expressed as an integer, followed by a single space, followed by one of the following periods:</maml:para> <maml:para>- day(s)</maml:para> <maml:para>- week(s)</maml:para> <maml:para>- month(s)</maml:para> <maml:para>- year(s)</maml:para> <maml:para></maml:para> <maml:para>Valid examples include:</maml:para> <maml:para>- "1 year"</maml:para> <maml:para>- "36 weeks"</maml:para> <maml:para>- "1024 days"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:Description> <maml:para>An array of strings to apply to the entry as tags. Multiword tags should not have spaces. Instead, separate words by dashes or underscores.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>New-JournalEntry -Tags work,running,exciting-day</dev:code> <dev:remarks> <maml:para>Creates a new journal entry for today, tagged `running`, `work`, and `exciting-day`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>New-JournalEntry -DateOffset -1</dev:code> <dev:remarks> <maml:para>Creates a new journal entry for yesterday.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Open-Journal</command:name> <command:verb>Open</command:verb> <command:noun>Journal</command:noun> <maml:description> <maml:para>Opens the journal's location on disk using the default operating system file viewer. Alias: `oj`</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Open-Journal</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Date</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>To</maml:name> <maml:Description> <maml:para>Specifies the location in the journal's file structure. The default is `CurrentMonth`.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">CurrentMonth</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CurrentYear</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Root</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Date</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>To</maml:name> <maml:Description> <maml:para>Specifies the location in the journal's file structure. The default is `CurrentMonth`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Open-Journal</dev:code> <dev:remarks> <maml:para>Opens the journal and navigates to the current month directory.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Open-Journal -To CurrentYear</dev:code> <dev:remarks> <maml:para>Opens the journal and navigates to the current year directory.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Open-JournalBackupLocation</command:name> <command:verb>Open</command:verb> <command:noun>JournalBackupLocation</command:noun> <maml:description> <maml:para>Opens the journal backup location, using the default operating system file viewer.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If the journal backup location has previously been saved, this command will open that directory using your system's file viewer. Otherwise, it will do nothing.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Open-JournalBackupLocation</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Open-JournalBackupLocation</dev:code> <dev:remarks> <maml:para>Opens the saved backup location, if it exists. Otherwise, it does nothing.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Open-JournalCliLogsDirectory</command:name> <command:verb>Open</command:verb> <command:noun>JournalCliLogsDirectory</command:noun> <maml:description> <maml:para>Open the application logs directory, if one exists.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>`journal-cli` logs all errors to the local disk. You can reference these logs when troubleshooting problems, or when opening a bug report.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Open-JournalCliLogsDirectory</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Open-JournalCliLogsDirectory</dev:code> <dev:remarks> <maml:para>Opens the directory that contains `journal-cli` application logs, if it exists. If no errors have ever been recorded, the directory will not exist. In that situation, a message will be displayed explaining that the directory does not exist.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Open-JournalEntry</command:name> <command:verb>Open</command:verb> <command:noun>JournalEntry</command:noun> <maml:description> <maml:para>Opens the specified journal entry using system's default editor for `.md` files. Alias: `oje`</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Opens a specific journal entry for editing or reading using the system's default markdown editor. Entries can be referenced by relative or specific date, file name, or by piping in journal entry objects from other cmdlets.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Open-JournalEntry</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Date</maml:name> <maml:Description> <maml:para>The date of the entry to open.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Open-JournalEntry</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>DateOffset</maml:name> <maml:Description> <maml:para>An integer representing the number of days to offset from today's date. For example, -1 represents yesterday. The default is 0, meaning today.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Open-JournalEntry</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Entry</maml:name> <maml:Description> <maml:para>An `IJournalEntry` object, generated from `Get-JournalIndex` or `Get-JournalEntriesByTag`. See Reading Entries With A Markdown Editor (https://journalcli.me/docs/features#reading-entries-with-a-markdown-editor)for additional information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IJournalEntry</command:parameterValue> <dev:type> <maml:name>IJournalEntry</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Open-JournalEntry</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>EntryName</maml:name> <maml:Description> <maml:para>The file name for a specific entry, with or with out the `.md` file extension.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Open-JournalEntry</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Last</maml:name> <maml:Description> <maml:para>Opens the most recent journal entry.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Date</maml:name> <maml:Description> <maml:para>The date of the entry to open.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>DateOffset</maml:name> <maml:Description> <maml:para>An integer representing the number of days to offset from today's date. For example, -1 represents yesterday. The default is 0, meaning today.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Entry</maml:name> <maml:Description> <maml:para>An `IJournalEntry` object, generated from `Get-JournalIndex` or `Get-JournalEntriesByTag`. See Reading Entries With A Markdown Editor (https://journalcli.me/docs/features#reading-entries-with-a-markdown-editor)for additional information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IJournalEntry</command:parameterValue> <dev:type> <maml:name>IJournalEntry</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>EntryName</maml:name> <maml:Description> <maml:para>The file name for a specific entry, with or with out the `.md` file extension.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Last</maml:name> <maml:Description> <maml:para>Opens the most recent journal entry.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>JournalCli.Core.IJournalEntry</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Open-JournalEntry '2019.01.02' # Or... PS C:\> Open-JournalEntry '2019.01.02.md'</dev:code> <dev:remarks> <maml:para>Opens the entry for January 1, 2019. If an entry does not exist for that date, an error is returned.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Open-JournalEntry (Get-Date -Year 2019 -Month 7 -Day 19)</dev:code> <dev:remarks> <maml:para>Opens the entry for July 19th, 2019 or throws an error if it doesn't exist. Pro Tip: You can use `Get-Date` to swap out the day, year, or month value in order to easily produce the desired date. For example, if today's date is November 11th 2019 and I run `Get-Date -Day 5`, PowerShell will return November 5th 2019.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Open-JournalEntry -DateOffset -1</dev:code> <dev:remarks> <maml:para>Opens yesterday's entry.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Get-JournalEntriesByTag -Tags insomnia | Select-Object -ExpandProperty entries | Open-JournalEntry</dev:code> <dev:remarks> <maml:para>Opens every entry tagged `insomnia`. Careful here. If a large number of entries are returned by `Get-JournalEntriesByTag`, you may find yourself quickly overwhelmed by markdown editor instances.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Open-RandomJournalEntry</command:name> <command:verb>Open</command:verb> <command:noun>RandomJournalEntry</command:noun> <maml:description> <maml:para>Opens a randomly selected journal entry using the system's default markdown editor. Alias: `orj`</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Opens a journal entry, randomly selected from either the entire journal or from a subset. The collection of possible entries can be limited by date range, tags, or both.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Open-RandomJournalEntry</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>From</maml:name> <maml:Description> <maml:para>Filters the index to journal entries that were written on or after the specified date.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:Description> <maml:para>One or more tags to filter the collection of possible journal entries. Multiple tags are applied as a boolean `OR`, not `AND`. Looking at Example 1 above, running that command will return all entries that include `vacation` OR `germany`. `AND` operations will be added in a later release.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>To</maml:name> <maml:Description> <maml:para>Filters the index to journal entries that were written on or before the specified date.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Year</maml:name> <maml:Description> <maml:para>Limits the pool of possible journal entries to the specified year.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>From</maml:name> <maml:Description> <maml:para>Filters the index to journal entries that were written on or after the specified date.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:Description> <maml:para>One or more tags to filter the collection of possible journal entries. Multiple tags are applied as a boolean `OR`, not `AND`. Looking at Example 1 above, running that command will return all entries that include `vacation` OR `germany`. `AND` operations will be added in a later release.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>To</maml:name> <maml:Description> <maml:para>Filters the index to journal entries that were written on or before the specified date.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Year</maml:name> <maml:Description> <maml:para>Limits the pool of possible journal entries to the specified year.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Open-RandomJournalEntry -Tags vacation,germany</dev:code> <dev:remarks> <maml:para>Opens a randonly selected journal entry that is tagged either `vacation` or `germany`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Open-RandomJournalEntry -From '2019.01.01' -To (Get-Date)</dev:code> <dev:remarks> <maml:para>Opens a randonly selected journal entry from January 1st 2019 to the current date.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Open-RandomJournalEntry</dev:code> <dev:remarks> <maml:para>Randomly selects an entry from any time in the journal.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Rename-JournalTag</command:name> <command:verb>Rename</command:verb> <command:noun>JournalTag</command:noun> <maml:description> <maml:para>Change the name of journal tag.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Iterate though all journal entries that contain the specified `OldName` and replaces it with the provided `NewName` name. Use the `-DryRun` switch to generate a list of all entries that would be altered without actually making the changes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Rename-JournalTag</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DryRun</maml:name> <maml:Description> <maml:para>Generates a list of entries that would be altered by the command, without actually making the changes.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NewName</maml:name> <maml:Description> <maml:para>The desired replacement name for the tag.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OldName</maml:name> <maml:Description> <maml:para>The name of the currently existing tag that should be renamed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DryRun</maml:name> <maml:Description> <maml:para>Generates a list of entries that would be altered by the command, without actually making the changes.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NewName</maml:name> <maml:Description> <maml:para>The desired replacement name for the tag.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OldName</maml:name> <maml:Description> <maml:para>The name of the currently existing tag that should be renamed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Rename-Tag -OldName cant-sleep -NewName insomnia -DryRun EntryName --------- 2019.10.11 2019.10.31 2019.11.01</dev:code> <dev:remarks> <maml:para>Displays a list of all entries currently tagged `cant-sleep`, without actually renaming the tags to `insomnia`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Rename-Tag -OldName cant-sleep -NewName insomnia</dev:code> <dev:remarks> <maml:para>Finds all entries currently tagged `cant-sleep` and renames the tag to `insomnia`.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Save-JournalSnapshot</command:name> <command:verb>Save</command:verb> <command:noun>JournalSnapshot</command:noun> <maml:description> <maml:para>Creates a snapshot of the current state of the journal, which can potentially be reviewed or reverted at a later time. Alias: `sjs`</maml:para> </maml:description> </command:details> <maml:description> <maml:para>All `journal-cli` commands which alter the state of your entry files, such as by adding new entries or renaming tags, automatically create snapshots before and after making the change. However, you can also create manual snapshots at any time by using `Save-JournalSnapshot`. These snapshots can be reviewed or reverted at any time. </maml:para> <maml:para>Under the hood, these snapshots are nothing more than git commits. `journal-cli` automatically creates a local git repository for tracking all changes to the journal. You can therefore review or revert every change ever made to your journal simply by using familiar git commands. Refer to the git integration page (https://journalcli.me/docs/git)for further information. NOTE: The git repository is never automatically pushed to a remote server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-JournalSnapshot</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>A short message that describes the current state of the journal. This should be less than approximately 75 characters.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>A short message that describes the current state of the journal. This should be less than approximately 75 characters.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Save-JournalSnapshot</dev:code> <dev:remarks> <maml:para>Creates a manual snapshot of the journal. If no changes have been made since the last snapshot, the command does nothing.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Save-JournalSnapshot -Message "Edited an old entry"</dev:code> <dev:remarks> <maml:para>Creates a manual snapshot of the journal, with the message "Edited an old entry". The message is used as the git commit message.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-JournalDefaultLocation</command:name> <command:verb>Set</command:verb> <command:noun>JournalDefaultLocation</command:noun> <maml:description> <maml:para>Sets the default location on disk for the journal.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Setting the default location for the journal allows you to omit the `-Location` parameter from most other `JournalCli` cmdlets. Further, you can have one default journal location while also maintaining other, secondary locations where additional journals are stored. When executing commands against a secondary journal location, the `-Location` will be necessary in order to override the default.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-JournalDefaultLocation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-JournalDefaultLocation C:\Users\EHumperdinck\Documents\Journal</dev:code> <dev:remarks> <maml:para>Sets the default journal location to `C:\Users\EHumperdinck\Documents\Journal`</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Suspend-JournalCliUpdateChecks</command:name> <command:verb>Suspend</command:verb> <command:noun>JournalCliUpdateChecks</command:noun> <maml:description> <maml:para>Temporarily snooze automated checks for new versions of the `journal-cli` module.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>By default, `journal-cli` will automatically check for new releases every 7 days. If you have the beta version installed, it will only search for new beta releases. Likewise, if you have the official release installed, it will only search for new official release versions. You can use this cmdlet to suppress these checks for a period of time, ranging from 1 to 365 days. The default is 45.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Suspend-JournalCliUpdateChecks</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Days</maml:name> <maml:Description> <maml:para>The number of days, ranging from 1 to 365, to suppress automated update checks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>45</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Days</maml:name> <maml:Description> <maml:para>The number of days, ranging from 1 to 365, to suppress automated update checks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>45</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Suspend-JournalCliUpdateChecks</dev:code> <dev:remarks> <maml:para>Discontinues automated update checks for the default 45 days.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |