Update CLI documentation for clarity and new features

This commit is contained in:
Roger Gonzalez 2024-12-26 10:52:39 -03:00
parent 3d096c69cf
commit 9bd7d9f194
Signed by: rogs
GPG Key ID: C7ECE9C6C36EC2E6

View File

@ -3,40 +3,89 @@ title: "Using the CLI"
date: 2023-01-10T17:55:41-03:00
draft: false
weight: 3
summary: YAMS comes with a very handy CLI to manage all your media server. Here's where you'll learn how to use it.
summary: Master YAMS's powerful command-line interface - your Swiss Army knife for managing your media server!
---
YAMS comes with a very handy CLI to manage your media server. Here's where you'll learn how to use it.
# The YAMS Command Line: Your Media Server's Best Friend 🛠️
On your server, you can type:
YAMS comes with a super handy command-line interface (CLI) that makes managing your media server a breeze! Think of it as your media server's remote control - but cooler. 😎
## Getting Started
To see what your YAMS CLI can do, just type:
```bash
yams --help
```
And you'll get the following message:
You'll get a nice overview of all available commands:
```bash
yams - Yet Another Media Server
Usage: yams [--help|restart|stop|start]
options:
--help displays this help message
restart restarts yams services
stop stops all yams services
start starts yams services
destroy destroy yams services so you can start from scratch
check-vpn checks if the VPN is working as expected
update updates YAMS
Usage: yams [command] [options]
Commands:
--help displays this help message
restart restarts yams services
stop stops all yams services
start starts yams services
destroy destroy yams services so you can start from scratch
check-vpn checks if the VPN is working as expected
backup backs up yams to the destination location
```
Everything is very self-explanatory, but I'll go in more detail here:
Let's break down each command and see what magic they can do! ✨
- `restart`: Restarts all the services. It stops them gracefully and starts them again.
- `stop`: Stops all the services gracefully.
- `start`: Starts all the services.
- `destroy`: Destroys all the services so you can start the configuration from scratch. ⚠️ Be careful! ⚠️ There's no going back after this!
- `check-vpn`: Checks the IP of the qBittorrent service and compares it to your own IP. If they are the same, it's going to warn you.
- `update`: Updates YAMS to the latest version available in the git repository.
## The Command Arsenal 🚀
### `yams start`
Fires up all your YAMS services. It's like pressing the "ON" button for your media server! The CLI will even show you a nice progress bar and let you know when everything's up and running.
If you get a `docker` permission error trying to use the CLI, go [here](/faqs/) to fix it.
### `yams stop`
Gracefully stops all YAMS services. Think of it as tucking your media server in for a good night's rest. 😴 All downloads will be paused, and all services will shut down properly.
### `yams restart`
Having a hiccup with one of your services? This command is like giving your media server a quick refresh! It:
1. Gracefully stops all services
2. Starts them back up
3. Shows you a progress bar while services are starting
4. Confirms when everything's back online
### `yams check-vpn`
Your privacy guardian! 🛡️ This command makes sure your VPN is doing its job by:
1. Checking your real IP address
2. Checking qBittorrent's IP address
3. Comparing them to make sure they're different
4. Showing you which countries both IPs are from
If something's wrong, it'll let you know right away!
### `yams backup [destination]`
Your safety net! 🎯 Backs up your entire YAMS configuration to keep your setup safe. Just tell it where to save the backup:
```bash
yams backup ~/my-backups
```
This will:
1. Stop all services (temporarily)
2. Create a timestamped backup file
3. Start everything back up
4. Tell you exactly where your backup is saved
### `yams destroy`
The nuclear option! ☢️ This command completely removes all YAMS services so you can start fresh. But don't worry - it'll ask for confirmation first! We don't want any accidents. 😅
## Pro Tips 💡
1. **Service Status**: After starting or restarting, YAMS will show you the status of each service, so you know everything's working properly.
2. **Backup Regularly**: Get into the habit of running `yams backup` before making any big changes. Future you will thank present you!
3. **Check That VPN**: Run `yams check-vpn` periodically to ensure your privacy is protected.
## Troubleshooting 🔧
Getting a `docker` permission error when trying to use the CLI? Don't panic! Head over to our [Common Issues](/faqs/common-errors/) page for the fix.
Remember: YAMS's CLI is here to make your life easier! If you're ever unsure about a command, just add `--help` at the end or check back here for a refresher. Happy streaming! 🎬