Skip to content

Feature request: optional aliases for directories #1122

@io41

Description

@io41

📌 Feature Request: Support for Custom Aliases for Directory Paths

Use-case:

As a developer, I frequently work with deeply nested project directories. For example, I often navigate to:

/Users/tim/foo/bar/complicated-project-name

Currently, zoxide allows me to jump to this directory using:

z complicated-project-name
# Or, depending on how much overlap there is between names, I could use fuzzy match:
z comp

but I cannot influence the name. If I want to use a name that's more meaningful to my context, such as the initials cpn, there's no way for me to do so using zoxide.

A custom alias to my complicated-project-name, such as cpn would help me, allowing me to run z cpn and have it resolve to the same directory. This would improve ergonomics and speed up navigation, especially when directory names are long, repetitive, or not easily memorable.

Why this matters:

  • Some directory names are auto-generated or follow naming conventions that aren't intuitive.
  • I often think in terms of project or domain names (e.g., cpn) rather than folder names (e.g., complicated-project-name).
  • Shell aliases or symlinks are workarounds, but they don’t integrate cleanly with zoxide’s fuzzy matching and ranking logic.

Suggested Feature:

Introduce a way to associate a custom alias with a directory path, such as:

zoxide alias cpn /Users/tim/foo/bar/complicated-project-name

or allow tagging during zoxide add:

zoxide add --alias cpn /Users/tim/foo/bar/complicated-project-name

This would allow users to jump to directories using meaningful, user-defined shortcuts while still benefiting from zoxide’s smart ranking and tracking.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions