Skip to content

SysadminMartin/WhatToDo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

42 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WhatToDo

A PowerShell to-do list module that uses the todo.txt format (https://github.com/todotxt/todo.txt).

WhatToDo


Get started

  1. Create a folder called WhatToDo in your PowerShell modules folder. You can find all your module folder paths by running the following PS command: $env:PSModulePath -split ';'
  2. Copy the two files (WhatToDo.psd1 and WhatToDo.psm1) from the Module folder into the newly created folder.
  3. Create a new folder that will store the configuration and task list files. This folder can exist wherever you want, but you'll need to refer to it when running the WhatToDo functions.
  4. Add Import-Module -Name 'path\to\WhatToDo\WhatToDo.psm1' to your PowerShell profile ($PROFILE), then reload your profile or start a new session.
  5. Run Initialize-WhatToDo -DirectoryPath 'path\to\WhatToDo'. Set the DirectoryPath value to the directory that should store your configuration and task list files.
  6. Run Start-WhatToDo -ConfigurationPath 'path\to\WhatToDo\WhatToDo-Config.psd1'. Set the ConfigurationPath value to the configuration file that was created in the WhatToDo directory.
  7. Run the help command in the WhatToDo prompt to show all available commands.
Import-Module -Name 'path\to\WhatToDo\WhatToDo.psm1'
Initialize-WhatToDo -DirectoryPath 'path\to\WhatToDo'
Start-WhatToDo -ConfigurationPath 'path\to\WhatToDo\WhatToDo-Config.psd1'

Bonus: Set default parameter value to auto-include configuration file for Start-WhatToDo

  1. Edit your PS profile ($PROFILE).
  2. Add the default parameter value somewhere in the profile.
$PSDefaultParameterValues['Start-WhatToDo:ConfigurationPath'] = 'path\to\WhatToDo\WhatToDo-Config.psd1'

Now you can run Start-WhatToDo without the ConfigurationPath parameter.

Start-WhatToDo

Bonus: Create shortcut to standalone session

Create a shortcut in Windows to launch WhatToDo in a standalone session. This will allow the Start-WhatToDo function to act as a standalone application.

Target: C:\Windows\System32\conhost.exe pwsh.exe -Command "Start-WhatToDo -ConfigurationPath 'path\to\WhatToDo\WhatToDo-Config.psd1'"

About

PowerShell to-do list module.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors