How to use the command "bashmarks" (with examples)

Bashmarks is a command-line tool that allows users to save and jump to commonly used directories using one-character commands. It provides an efficient way to navigate through the file system by creating bookmarks for frequently accessed directories.

Use case 1: List available bookmarks

Code:

bashmarks l

Motivation: This command is useful to display a list of all available bookmarks in the current session. It helps users to quickly see the saved bookmarks and choose the desired directory to navigate to.

Explanation: The command “l” stands for “list” and is used to list all available bookmarks. Bashmarks will display the names of the bookmarks along with the corresponding directories.

Example output:

bookmarks:
bookmark1: /path/to/bookmark1
bookmark2: /path/to/bookmark2
bookmark3: /path/to/bookmark3

Use case 2: Save the current directory as a bookmark

Code:

bashmarks s bookmark_name

Motivation: This command allows users to save the current directory as a bookmark with a specified name. It is particularly useful when working on a project with deep directory structures, as it helps to easily return to the project root or any other frequently accessed directories.

Explanation: The command “s” stands for “save” and is followed by the desired name for the bookmark. Bashmarks will save the current directory and associate it with the provided name.

Example output: No output is displayed when saving a bookmark.

Use case 3: Go to a bookmarked directory

Code:

bashmarks g bookmark_name

Motivation: This command enables users to quickly navigate to a bookmarked directory without having to remember or type the full path every time. It saves time and reduces the chances of making typing errors.

Explanation: The command “g” stands for “go” and is followed by the name of the bookmarked directory. Bashmarks will change the current directory to the bookmarked directory associated with the provided name.

Example output: No output is displayed when navigating to a bookmarked directory.

Use case 4: Print a bookmarked directory’s contents

Code:

bashmarks p bookmark_name

Motivation: Sometimes it is necessary to quickly inspect the contents of a bookmarked directory without changing the current working directory. This command provides a convenient way to do so.

Explanation: The command “p” stands for “print” and is followed by the name of the bookmarked directory. Bashmarks will display the contents of the bookmarked directory associated with the provided name.

Example output:

file1.txt
file2.txt
folder1
folder2

Use case 5: Delete a bookmark

Code:

bashmarks d bookmark_name

Motivation: Over time, bookmarked directories may become obsolete or no longer needed. This command allows users to remove bookmarks that are no longer required, decluttering the list of available bookmarks.

Explanation: The command “d” stands for “delete” and is followed by the name of the bookmark to be deleted. Bashmarks will remove the bookmark associated with the provided name.

Example output: No output is displayed when deleting a bookmark.

Conclusion:

Bashmarks is a powerful command-line tool for saving and navigating through commonly used directories. With the ability to create, list, navigate, and delete bookmarks, users can increase productivity by quickly accessing important directories without having to remember or type the full path.