external help file | Module Name | online version | schema |
---|---|---|---|
PSWorkItem-help.xml |
PSWorkItem |
2.0.0 |
Open the PSWorkItem management TUI-based console
Open-PSWorkItemConsole [-Path <String>] [<CommonParameters>]
This command will launch a terminal-based console for managing PSWorkItems. You can select items from the table which will populate the entry forms. You can then modify the work item and click Set-PSWorkItem, or you can mark the item as complete or remove it. To enter a new PSWorkItem, use Options - Clear Form. Enter your new item, selecting a category from the list, and click the Add New PSWorkItem button. You cannot set a progress value when creating a new work item.
You can right-click a task in the table to show detailed information.
Use the category menu options to add, set, or remove a category.
You can also enter a different database path by entering the path in the Database field, or using Options - Open database. Use the Reset Form option to reset the form with your default settings.
PS C:\> Open-PSWorkItemConsole
Open the management console using the default $PSWorkItemPath variable. You can also use the wic alias.
PS C:\ OpenPSWorkItemConsole c:\work\personal.db
Open the management console using an alternate database.
The path to the PSWorkItem SQLite database file. It must end in .db
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: $PSWorkItemPath
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You cannot specify a PSWorkItem completion date using this tool.
If you have difficulty seeing the cursor in text fields, and you are running in Windows Terminal, you might try changing the cursor in your Windows Terminal profile setting. The TUI color scheme is also influenced by the Windows Terminal color scheme. It will have a different appearance under different Windows Terminal color schemes. You may also have to adjust the zoom level in Windows Terminal to see the entire form.
IMPORTANT: This command relies on a specific version of Terminal.Gui assembly. You might encounter version conflicts from modules that use older versions of this assembly like Microsoft.PowerShell.ConsoleGuiTools. You may need to load this module first in a new PowerShell session.