Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/donbuehl/zsh-unraid
This plugin adds convenient aliases and functions for managing your unRAID server directly from the command line.
https://github.com/donbuehl/zsh-unraid
Last synced: 8 days ago
JSON representation
This plugin adds convenient aliases and functions for managing your unRAID server directly from the command line.
- Host: GitHub
- URL: https://github.com/donbuehl/zsh-unraid
- Owner: donbuehl
- License: mit
- Created: 2024-09-11T12:43:06.000Z (13 days ago)
- Default Branch: main
- Last Pushed: 2024-09-13T11:18:34.000Z (11 days ago)
- Last Synced: 2024-09-13T23:10:23.823Z (11 days ago)
- Language: Shell
- Size: 18.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- trackawesomelist - unraid (⭐0) - Adds convenient aliases and functions for managing your Unraid server directly from the command line. (Recently Updated / [Sep 15, 2024](/content/2024/09/15/README.md))
README
# Unraid Oh My Zsh Plugin
This plugin adds convenient aliases and functions for managing your Unraid server directly from the command line.
## Installation
1. Clone this repository into your Oh My Zsh custom plugins directory:
```
git clone https://github.com/donbuehl/zsh-unraid.git ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/unraid
```
2. Add `unraid` to your plugin list in your `.zshrc` file:
```zsh
plugins=(... unraid)
```
3. Reload your `.zshrc` or restart your shell:
```
source ~/.zshrc
```
## Features
### Array Management
- `array-start`: Start the Unraid array
- `array-stop`: Stop the Unraid array
### User Scripts
- `list-scripts`: List all user scripts
- `run-script `: Run a specific user script
### Docker Management
- `docker-list`: List running Docker containers
- `docker-start `: Start a Docker container
- `docker-stop `: Stop a Docker container
### VM Management
- `vm-list`: List all VMs
- `vm-start `: Start a VM
- `vm-stop `: Stop a VM
### Quick Directory Navigation
- `cdboot`: Change to /boot
- `cdextras`: Change to /boot/extras
- `cdappdata`: Change to /mnt/user/appdata
- `cddomains`: Change to /mnt/user/domains
- `cdisos`: Change to /mnt/user/isos
- `cdshare`: Change to /mnt/user/share
- `cddisks`: Change to /mnt/disks
### Plugin Directory Navigation
- `cdplugin `: Change to the plugin's directory (checks config first, then emhttp)
- `cdpluginconf `: Change directly to the plugin's config directory
- `cdplugincode `: Change directly to the plugin's code directory
### System Information
- `unraid_info`: Display a summary of Unraid system information
## Notes
- Some features may require additional plugins or configurations on your unRAID system.
- This plugin is designed to work with Unraid 6.x and later versions.
- Always exercise caution when using commands that modify your array or system configuration.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.