zsh-buddy/README.md

A better Stacks zsh experience.

# zsh-buddy

This package contains the zsh-buddy plugin.

## ☘️ Features

- It will find and execute `buddy` from anywhere within the project file tree _(and you don't need to prefix it with php or ./)_
- It provides auto-completion for `buddy` commands _(that also work anywhere within the project)_
- You can specify an editor to automatically open new files created by `buddy make:*` commands

## 🤖 Usage

```
buddy setup:oh-my-zsh
```

To view the full documentation, please visit [https://stacksjs.org/ui](https://stacksjs.org/zsh).

## 🧪 Testing

```bash
# wip
```

## 📈 Changelog

Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.

## 🚜 Contributing

Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details.

## 🏝 Community

For help, discussion about best practices, or any other conversation that would benefit from being searchable:

[Discussions on GitHub](https://github.com/stacksjs/stacks/discussions)

For casual chit-chat with others using this package:

[Join the Stacks Discord Server](https://discord.gg/stacksjs)

## 🙏🏼 Credits

Many thanks to the following core technologies & people who have contributed to this plugin:

- [Jess Archer](https://github.com/jessarcher/zsh-artisan/blob/master/artisan.plugin.zsh)
- [Chris Breuer](https://github.com/chrisbbreuer)
- [All Contributors](../../contributors)

## 📄 License

The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.

Made with 💙