https://github.com/dir/raycast-z

❯ seamless zoxide integration for Raycast
https://github.com/dir/raycast-z

bash raycast raycast-script z zoxide

Last synced: 4 months ago
JSON representation

❯ seamless zoxide integration for Raycast

• Host: GitHub
• URL: https://github.com/dir/raycast-z
• Owner: dir
• License: mit
• Created: 2025-02-03T04:35:16.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2025-02-03T07:24:57.000Z (4 months ago)
• Last Synced: 2025-02-15T18:44:39.989Z (4 months ago)
• Topics: bash, raycast, raycast-script, z, zoxide
• Language: Shell
• Homepage:
• Size: 632 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

    

  

  
raycast-z

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

  


  

    

  

  




## Requirements

- [Raycast](https://raycast.com) installed on your system

- [zoxide](https://github.com/ajeetdsouza/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](https://github.com/raycast/script-commands?tab=readme-ov-file#install-script-commands-from-this-repository))

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](https://ray.so/ZJ1T7XP)

4. Test your new command in Raycast