Anything planned for Windows? Preferably: installation via WinGet/Scoop, publishing Windows binaries alongside Linux/macOS on GitHub release, etc.

When searching github for z topics, zoxide isn't listed. It will improve discovery.

Thank you, works great!

I'd much prefer to use skim over fzf

CMD

tmux new-session -t a \; new-window

Error mesg

could not move temporary database file: No such file or directory (os error 2)

Hello, I installed zoxide according to the instructions in the README file. I also initialized it for fish shell.

Now, when I cd into any directory, I get this error:

error: Found argument '--add' which wasn't expected, or isn't valid in this context

USAGE:
    zoxide query [FLAGS] [keywords]...

For more information try --help

zoxide --version
zoxide 0.2.1

fish --version
fish, version 3.0.2

Any help with this?

Would be nice to have POSIX sh support instead of just Bash. Would allow people to use zoxide on a wide variety of shells.

The Bash init script doesn't seem too far from being POSIX.

cd goes to the home directory when invoked without args. Maybe z could do the same?

Something that z.lua, z.sh, and z (fish) all have is a way to exclude/blacklist specific directories from the database. This would be useful to ensure that my home directory doesn't have an enormous rank (due to it being where my shell starts up initially), as well as hiding potentially sensitive/hidden/otherwise secret directories that should not be recorded.

Every time I open up zi and see my home directory, I am reminded of this, so I wanted to submit a formal (tracking) issue for it.

Hi
I have opened a pull request over on NixOS/nixpkgs for inclusion of this tool in the nix package repo.

In keeping with the Rust theme it might be nice to support fuzzy matching with skim in addition to fzf.

The skim binary is as far as I could tell a direct drop-in replacement for fzf built with rust. I have never used their library but their example on their README

# Cargo.toml
[dependencies]
skim = "0.7.0"

extern crate skim;
use skim::prelude::*;
use std::io::Cursor;

pub fn main() {
    let options = SkimOptionsBuilder::default()
        .height(Some("50%"))
        .multi(true)
        .build()
        .unwrap();

    let input = "aaaaa\nbbbb\nccc".to_string();

    // `SkimItemReader` is a helper to turn any `BufRead` into a stream of `SkimItem`
    // `SkimItem` was implemented for `AsRef<str>` by default
    let item_reader = SkimItemReader::default();
    let items = item_reader.of_bufread(Cursor::new(input));

    // `run_with` would read and show items from the stream
    let selected_items = Skim::run_with(&options, Some(items))
        .map(|out| out.selected_items)
        .unwrap_or_else(|| Vec::new());

    for item in selected_items.iter() {
        print!("{}: {}{}", item.get_index(), item.get_output_text(), "\n");
    }
}

seems simple enough.

At the moment, this is intended behavior (and also the behavior of most other jumpers).

I am of the opinion that we should have some way to allow the user to decide if they want to add a directory on every prompt redraw, or on every PWD change (see the "Prior art" section below for how our predecessors do this). Although a departure from what the other jumpers have named theirs, maybe introducing $_ZO_WATCH_PWD to choose whether or not a directory is added on each prompt redraw, or every time PWD is changed, is the solution here.

I also believe that any more complicated setup should be up to the user.

To be clear: this issue is supposed to be one for discussing what action should be taken here.

Prior art

z (original) has the $_Z_NO_PROMPT_COMMAND env var to allow the user to disable this functionality (or handle it themselves).

z.lua has $_ZL_ADD_ONCE (and an --init once flag) which controls this.

z (fish edition) only adds when PWD changes, and has no option to modify this behavior.

cc @ajeetdsouza

Something similar to query -i but without fzf.

Hello,

i have an error that i do not know to resolve. I guess it can be an error about the storage, maybe i should remove the file ?

あ→ z
Error: could not deserialize database

Caused by:
    io error: failed to fill whole buffer

Some information

あ→ uname -a
Linux DESK-HOME 5.5.9-arch1-2 #1 SMP PREEMPT Thu, 12 Mar 2020 23:01:33 +0000 x86_64 GNU/Linux

Thank you for your awesome plugin :)

An excellent addition would be a ranger plugin like this:
https://github.com/skywind3000/z.lua/blob/master/ranger_zlua.py

Thank you

I request that zoxide query simply result the path without a query: prefix.

That way you can use the result immediately as argument to other commands.

My primary interest is that I want to easily open VSCode on various codebases. Currently it's easiest if I run z <keyword>; code . in a new terminal and then close it again, but it would be easier if I could instead just do code $(zq <keyword>). As this doesn't modify the current directory of the terminal, I could execute this from any of the terminals I already have open.

Bash version: bash 5.0.17
Zoxide version: zoxide v0.4.1-unknown

I use Manjaro and installed zoxide from AUR. I have added eval "$(zoxide init bash)" to my .bashrc file sourced it and also rebooted but zoxide init still can't recognize my shell.

Picture from the error:

I am running this on windows 10 cygwin. I built zoxide with windows cargo and I do have /usr/bin/fzf which works fine.

Error: could not launch fzf

Caused by:
The system cannot find the file specified. (os error 2)

Steps to reproduce

• Install zoxide: cargo install zoxide -f
• Add the hook to $PROFILE
• Restart terminal
• Go to some dir with zoxide: z some_dir
• Check zoxide dir: ls C:\Users\UserName\AppData\Local\zoxide (Error! No such directory!)
• Try to match with zoxide: z some (Error! No matches!)
• Check zoxide dir again: ls C:\Users\UserName\AppData\Local\zoxide (Ok! Now it exists but there is still no db file)

Additional info

I am running the default powershell available on windows ($PSVersionTable.PSVersion.Major yields 5, thus the hook defaults to 'prompt' according to the README powershell snippet)

Would be nice to support ion shell too 👼.

Use cases:

• Users who want a fresh start
• Resolving database corruptions

XDG_CONFIG_HOME provides a nice clean place to store config. Would be awesome if zoxide supported it by default.
https://wiki.archlinux.org/index.php/XDG_Base_Directory

I'm planning to introduce some breaking changes to the way zoxide works in the next release. I will put my ideas into the comments below so they can be addressed separately. The idea is that we should do this as little as possible, so we should club the changes to ensure that users are least inconvenienced.

I'd love to see this tool as brew package as well as on the arch user repository.

Hi,
Giving this example, with one symlink to another directory:

$ ls ~/tmp
  foo -> foo-target
  foo-target

If I cd into ~/tmp/foo, zoxide will follow the symlink and stores this target (foo-target) in its database. So if I do:

$ zq foo
/home/anthony/tmp/foo-target

Which is a bit non-intuitive for me. Do you see a possibility of adding an option to ignore symlinks, and consider them as normal folders?

I'm using Fish for my shell and all of a sudden I started getting this error:

Error: could not deserialize old database

Caused by:
    io error: failed to fill whole buffer

Any idea why this might've started happening? I really loved zoxide btw so great work! Hopefully I can fix this because it's been getting annoying

Not sure what I'm missing but I can't get zoxide working.

• OS: Arch Linux
• shell: zsh 5.8-1

What I did:

1. Installed zoxide^AUR
2. Added eval "$(zoxide init zsh)" to my ~/.zshrc

When opening a terminal, I get:

error: Found argument 'init' which wasn't expected, or isn't valid in this context

USAGE:
    zoxide [SUBCOMMAND]

For more information try --help
~ ➜ z ~/Documents
zsh: command not found: z
~ ➜ 

Note that I'm also using zinit plugin manager.

What could be the issue? Thanks in advance for any help.

Hi,

It would be awesome to have the same ability as z.lua to list entries with/without scores, equivalent of z -l and z -l -s.

I was using these to have my own equivalent of
zi foo # cd with interactive selection using fzf

since zoxide is taking care of it, I have some suggestions on this.

Practically, I never look/worry about scores, it would be great to be able to list entries with fzf without scores.

One nitpick also is to automatically cd to the directory if there is only one match which is not the case currently.

Thanks !

When zoxide remove is called and no entry is found, it should return an error.

my env

issue

The output for z or zi is:

~$ z -h
zoxide-query 0.2.0
Search for a directory

USAGE:
    zoxide query [FLAGS] [keywords]...

FLAGS:
    -h, --help           Prints help information
    -i, --interactive    Opens an interactive selection menu using fzf
    -V, --version        Prints version information

ARGS:
    <keywords>...    ~$ 

What I expect is the output below

~$ z -h
zoxide-query 0.2.0
Search for a directory

USAGE:
    zoxide query [FLAGS] [keywords]...

FLAGS:
    -h, --help           Prints help information
    -i, --interactive    Opens an interactive selection menu using fzf
    -V, --version        Prints version information

ARGS:
    <keywords>...    
~$ 

Would you consider having an option like _ZO_VERBOSE that would print the full path of the directory that z picked?

$ z tr
/home/np/rustuff/track

Feel free to close this issue if it has already been implemented, I am not the most attentive of readers ;)

I guess you must have different approaches but maybe it could help if both projects would work together.

But maybe those autojumper tools are simple enough that it's not like they need thousands and thousands of work hours on them and just need to be maintained after a while.

Hi, great job on your tool!

I know you can configure the database location using $_ZO_DATA, but as a possible enhancement, I hope you will consider setting the default to XDG_CACHE_HOME/zo for the people that use the tool with default settings.

https://wiki.archlinux.org/index.php/XDG_Base_Directory#Specification
https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html

Thanks!

Would be great to have an init method. This would allow us to source $(eval zoxide init zsh) and stay up to date if you make a script change in the future.

It would be awesome to tab complete the top rated entries.

Side note: All the tickets are because your tool is awesome :) 🥇

Hi, I'm coming from using autojump after being recommended this from a coworker. I love the blazing speed of zoxide.

Below are some examples for fuzzy matching.

( Note: you can see the echo that's mentioned in #22 )

I also miss jo (open matching directory. for mac this is something like open (zoxide query $argv) )

I had zoxide 0.1.1 installed and encountered the database corruption issue described in #68.
I installed the new version and received the following error message:

Error: could not deserialize old database

Caused by:
    io error: failed to fill whole buffer

I think zoxide should document the default database locations and also print the database file path when it can't be read.

I installed zoxide with brew install ajeetdsouza/zoxide/zoxide

The binary has to be compiled from source when I install with linuxbrew. Is that a bug? I think it should download the precompiled binary in the github release page.

I'd love to be able to use zoxide from Nu Shell.

The recent _ZO_ECHO changes made fish shell return an error status after jumping to any directory (see the below screenshot). This doesn't affect functionality, but is certainly annoying and wrong behavior, considering it didn't behave like this before.

(I've verified the issue is unrelated to direnv, to assuage any concerns)

Bisected to:

f4cd1159c5419ece11b1d0147c23dba1c7579edc is the first bad commit
commit f4cd1159c5419ece11b1d0147c23dba1c7579edc
Author: Ajeet D'Souza <[email protected]>
Date:   Sun Mar 15 17:44:23 2020 +0530

    Add $_ZO_ECHO to echo match before navigating

 src/subcommand/init.rs | 26 +++++++++++++++++---------
 1 file changed, 17 insertions(+), 9 deletions(-)

Disclaimer: this may be present in other shells, but I only use fish.

Advantages:

• Richer data structures allow us to represent things like lists (eg. #48, #60) in a more user-friendly manner. Being a specialized format, it also reduces the change of parsing errors (see #48 - what if a directory had a : in the name?).
• It is less prone to human error, since an misspelled/deprecated variable in the config file will throw an error/warning immediately.
• Config files, IMHO, tend to be a lot more manageable than environment variables, and can be backed up along with the rest of one's dotfiles. An additional advantage here is that one can use the same config file across shells.

@cole-h presented some interesting insight into the issue, and I'll add my comments here:

Want to test something? _ZO_DATA_DIR=/tmp/zo zoxide add /tmp. Want to change the max age for a single shell session? export _ZO_MAXAGE=9999 (or however you achieve that in any arbitrary shell).

I think this is a fairly limited use case, and isn't likely to affect most people. For the people that need it, they can keep an editor open with a temporary config file and change it as desired.

If we ship a default configuration file, we then have to make sure users know when new options are added, or options are deleted/deprecated. If we don't ship a default configuration, we have to make sure users know how to create their own.

We will ensure that zoxide works out of the box with zero configuration. The only use of the config file is for those users that would like to change the default behaviour.

It also becomes another folder related to zoxide on users' filesystems: their local data dir for the database itself, and now the config dir for the configuration file.

This is true, but since the user never has to deal with the data directory, it mostly just becomes an issue of managing the one config file (versus managing environment variables in one's shell rc file).

The file format itself also brings with it a whole host of issues, see: the many different "bugs" filed on Alacritty's issue tracker about configuration -- improper indentation, duplicate keys, unused keys, etc., in their case of YAML.

Looks like they're seriously considering shifting to TOML too, since YAML is too error-prone as a file format. They do mention that TOML would solve most issues, though.

Another disadvantage I can think of is that this will likely result in a slight slowdown, since we have to read another file, and, unlike environment variables, we can't selectively parse only the values that we need. That said, this shouldn't be a very significant slowdown, and I think we should favour usability over speed.

I started using zoxide and am very impressed by its speed compared to other utilities. Am currently using zsh-z. It would be nice if there was a way to import the entries from the earlier $HOME/.z to zoxide database. Any plans on using the existing data?

Hi,

It would be awesome to be able to install via homebrew
https://github.com/ajeetdsouza/zoxide

Project looks really good!

I'd like to try this as a replacement for zsh-z, but use z for something else and don't want to have to do a dance of redefining. I currently init zsh-z with:

ZSHZ_CMD=j ZSHZ_NO_RESOLVE_SYMLINKS=1 . ~/Code/zsh-z/zsh-z.plugin.zsh

And am looking for something similar to that or like:

eval "$(zoxide init --no-define-aliases --cmd j zsh)"

Trying to install with fisher, I get:

added 7 packages, removed 6 packages in 1.37s
zoxide: command not found
init.fish (line 2): 
    zoxide add
    ^
in function 'zoxide-add'
in event handler: handler for generic event “fish_prompt”

Install went well:

⚡️ 14% at 🕙 22:52:00 🚀 ᐅ curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/ajeetdsouza/zoxide/master/install.sh | sh
Detected target: x86_64-apple-darwin
Downloading zoxide...
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   617  100   617    0     0   2722      0 --:--:-- --:--:-- --:--:--  2730
100  862k  100  862k    0     0  1157k      0 --:--:-- --:--:-- --:--:-- 3102k
curl: Saved to filename 'zoxide-x86_64-apple-darwin'
Password:
zoxide is installed!
Please ensure that /usr/local/bin is added to your $PATH.

Though adding eval "$(zoxide init zsh)" to .zshrc throws:

zsh: defining function based on alias `z'
zsh: parse error near `()'

Twice in the last month, since I have started using zoxide, the database has become corrupted and I've lost my history.

This manifests as zoxide: could not read from database messages at each command prompt; ~/.zo is zero bytes.

I think this has something to do with killing a process using ctrl-c but I haven't been able to reproduce this yet. I'm using oh-my-zsh.

when I hit ecs to quit fzf, the prompt show an error that fzf has been terminated. I think that's the normal behavior of fzf and should not be an error.

In readme.md, antigen instructions say to

antigen bundle zsh-users/zsh-syntax-highlighting

But I don't see how that can work. Indeed, the obvious

antigen bundle ajeetdsouza/zoxide

Seems to do the trick.

It'd be nice to use standard config folders for this tool instead of just dropping configs and the database at the home folder for a user.

if you're interested about having this implemented, crates like this one can be used to accomplish this easily.

Happy to work on a PR if there's interest.