raycast-z

Seamless zoxide integration for Raycast. Ergonomic script commands for navigating and managing your directories.

Requirements

• Raycast installed on your system
• zoxide installed and setup in your shell

Installation

1. Clone this repository
2. Add the commands directory as a Script Directory in Raycast (installation guide)
3. If you're using an IDE other than VS Code, set your editor in commands/edit.sh, due to how Raycast runs scripts, $EDITOR may not be available, so it is set manually. Defaults to code for VS Code.
4. Launch Raycast and try it out!

Usage

The raycast-z commands leverage your existing zoxide database (automatically built as you navigate in your shell) to quickly access directories.

Simply enter a directory name or pattern, and z will find the best match.

You can also use absolute paths directly, even if they're not in your zoxide database.

Creating Custom Actions

1. Create a new script command {action}.sh in the commands directory, using open.sh as your template
2. Update the command call from _z "$1" open . to your desired action: _z "$1" {your_command}

   The _z function (defined in lib/_z.sh) handles the zoxide query and command execution in the target directory

3. Configure the @raycast.* metadata to your needs

   Need a custom icon? Use our ray.so template

4. Test your new command in Raycast