twd-m4sc0 1.5.4

A tool to temporarily save and go to a working directory

twd-m4sc0

twd-m4sc0 is a command-line tool that allows you to temporarily save a working directory and easily navigate back to it. It's designed for developers and users who frequently need to switch between directories in the terminal.

Features

• Save the current or specified working directory.
• Go back to a saved directory using an optional alias.
• List all saved directories with metadata.
• Unset and delete saved directories.
• Integrates with your shell for seamless directory management.

Installation

Installation using pip:

1. Install the package from the pypi repository:

pip install twd-m4sc0

2. Add the following line to your .bashrc or .zshrc to set up the shell function:

Since 1.5.4 you can also set a different command for the twd program by replacing [alias] in the following code by your custom alias

eval $(python3 -m twd --shell [alias])

3. Exit and reopen the terminal or reload using:

source ~/.bashrc
# or
source ~/.zshrc

Usage

Save a directory

• Save the current directory or a specified directory:

twd -s [path] [alias]

If no path is specified, the current directory is saved. The alias is optional, and if not provided, an auto-generated ID will be used.

Go to a saved directory

• Navigate to a saved directory using an optional alias:

twd -g [alias]

If no alias is provided, the most recently saved directory will be used. If an alias is provided, it will navigate to the directory associated with that alias.

List saved directories

• Display a list of all saved directories:

twd -l

Unset the TWD and delete the data file

• Unset and delete the saved directories:

twd -u

You can force this action using the --force flag to avoid accidental execution.

twd -u --force

Optional Parameters

Simple Output

For cleaner, minimal output intended for scripting or piping.

• Example with --simple-output:

twd -s --simple-output
/home/user/.config

• Example without --simple-output:

Saved TWD to /home/user/.config

No Output

Suppresses all output (including confirmation messages).

• Example with --no-output:

twd -s --no-output
# No output

Force

Use the --force flag to force certain actions, such as when unsetting directories with the -u flag.

• Example:

twd -u --force
TWD File deleted and TWD unset

Contribution

To set up a development environment:

1. Clone the repository:

git clone https://github.com/m4sc0/twd
cd twd

2. Install the package in editable mode using pip:

pip install -e .

3. Make your changes, and contribute!