GitXplorerGitXplorer
j

to-directory

public
4 stars
1 forks
13 issues

Commits

List of commits on branch master.
Verified
76eb7fbe414431bef7154043b612ae15bb959c04

Upgrades most crates

jjxson committed 3 years ago
Verified
ce5acb1b80180c0602e25fca12d9a418b821efd9

Updates failure crate to 0.1.8

jjxson committed 3 years ago
Verified
0a83587a8aba493c5d694577c01933d8a717bbdd

Updates rust version

jjxson committed 3 years ago
Verified
60b50729e71487a73fac189b6e08fff54b44df1c

Updates cargo lock file

jjxson committed 3 years ago
Verified
d60d9ee0fe1feca25faba8a72d5209b107bfc43e

remove unused error

jjxson committed 6 years ago
Verified
83b9b17cf951dfe6cb4280660505f471a2e1e14b

Refactor to use failure

jjxson committed 6 years ago

README

The README file for this repository.

to

A CLI utility for bookmarking directories with tab completion.

Travis branch Coverage Status

This is a Rust implementation of the excellent shell script autochthe/to. I (jxson) created this utility as a way to learn the Rust programming language and hopefully provide a stable cross-platform experience.

NOTE: Contributors with Windows experience wanted, open an issue and I will add you to the project.

Stability: Experimental

Expect the unexpected. Please provide feedback on the CLI, code APIs and your use-case.

This code is under active, exploratory development. Any documentation below should be considered aspirational and is not yet reflective how how to work with this tool.

Installation

Add the prebuilt binary to your path.

curl prebuilt.tar > $PREFIX/bin

Add the initialization command to your profile.

if which to-directory > /dev/null; then eval "$(to-directory --init)"; fi

Source your profile to pick up the new configuration. For example, if the line above was added to your ~/.bashrc you can:

source ~/.bashrc

Now every time you log in, the abbreviated to command will be available and allow you to quickly cd into your saved directory bookmarks. Run the help command to learn how to get started:

to --help

Development

Debugging

This project uses error-chain, a crate that enables the behavior of being able to see the cascade causes for a given error when it occurs (among a bunch of other handy features). By default the to command and it's companion Rust binary to-directory attempt to adhere to the rule of silence, which is good for users but not ideal during development and debugging.

To enable verbose errors use the # flag:

to --#

To control logging levels and structured logging output use the # flag:

to --log-level=debug --log-output=json

Note these are different from the --verbose flag in that they allow finer grain control and visibility over the user friendly, verbose output.

Backtraces

RUST_BACKTRACE=1 cargo run