PsLocations

Powershell command line interface (cli) for powershell to bookmark locations on the file system

WORK IN PROGRESS, NOT YET READY FOR USE, BUT SOON HOPE :)

DONE All commands to be in first version implemented and being dogfooded on my mac
DOING Currently writing Pester tests
DOING Dogfooding and testing on my windows machine
NEXT Dogfooding and testing on my linux machine (wsl on my windows machine)
DOING User documentation here in readme
NEXT Publish to the gallery

Loc -- Work in progress

The Loc command line interface (CLI) is a tool for managing and navigating folder bookmarks with ease. This guide provides detailed usage instructions for each action available in the Loc CLI.

Installation

By cloning this repository

In a powershell terminal session:

clone https://github.com/Aha43/PsLocations.git
cd PsLocations
./tools/import.ps1

From Powershell Gallery

TODO when published to the gallery

Configurations

Left to its own devices the system will store location data in a directory names ´.locations´ in user´s home directory. This can be overwritten by setting the value of the environment variable LocHome. Since locations can be shared over machines

Basic commands to manage and use locations (aka bookmarks)

Bookmarks are called locations in this context and allow terminal command line users to move to much used working directories with out a series of cdcommands or tedious path completions. To add current working directory as a location

loc add . 'Repository root of my amazing project'

The . says use directory name as name for location and last parameter is a mandatory description.

Note: In the following commands that accepts . for meaning current working directory's location will have . listed as an alternative in the command's second argument.

If you want to use another name for the location than the directory name:

loc add DaAmazingProject 'Repository root of my amazing project'

To list locations:

loc l

To move to a location

loc DaAmazingProjec

If you remember the position of the location as listed by loc l, say 0 you can move to location

loc 0

Note: In the following pos will refer to the location's position in the list provided by loc l. Be aware that a location's position most likely change as locations are added or removed.

Also loc go <name | pos> and loc goto <name | pos> will work

To remove a location (the bookmark, not the actual bookmarked directory!)

loc remove <location-name | . | pos>

If you need to rename a location

loc rename <location-name | . | pos> <new-name | .>

Note that loc . . will rename location (if it have one) for current working directory to the name of the directory.

To change the description of a location

loc edit <location-name | . | pos> <new-description>

You can add notes to locations, adding a note

loc note <location-name | . | pos> <note>

List notes for a location

loc notes <location-name | . | pos>

Aha43/PsLocations