Metadata-Version: 2.1
Name: term-mark
Version: 0.1.3
Summary: Bookmarks for your terminal
Author: Andrew Stone
License: Copyright (c) 2023 Andrew Stone
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/exastone/term-mark
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# term-mark • bookmarks for your terminal 📚

Bookmark directories to quickly jump to them later

![Jump to path](https://github.com/exastone/term-mark/blob/dev/assets/demo-mark-long-path.gif)

## Install

`pip install term-mark`

Because python cannot directly write to a terminals input buffer (stdin) and any directory changes to the terminal will
revert after the
program terminates, to make term-mark work you need to wrap the program execution in a shell function that runs
term-mark which can facilitate directory navigation.

term-mark handles the setup for you, but before you can use `tm` you need to run:

`term-mark --init`

This creates a shell function `tm.zsh` in `$HOME/.config/zsh/zsh_functions` and sources it your .zshrc file.

One last thing: you'll likely need to reload your .zshrc file

`source $HOME/.zshrc`

You can now use term-mark with `tm`!

## Uninstall

`pip uninstall term-mark`

Delete the shell function:

`rm $HOME/.config/zsh/zsh_functions/tm.zsh`

If you don't have anything else in this directory you can also delete the entire directory:

`rm -r $HOME/.config/zsh/`

Remove the following line from your .zshrc file:

`source "$HOME/.config/zsh/zsh_functions/tm.zsh"`

## Attribution

This CLI tool includes code and components from the [InquirerPy](https://github.com/kazhala/InquirerPy) package created
by kazhala, specifically a fork from [Gracer](https://github.com/Gracecr/InquirerPy)

InquirerPy is a powerful Python library for creating interactive command-line interfaces.
