Grav CLI Tools — bin/grav Commands, Automation and Maintenance

# Start development server
bin/grav server

# Start on specific port
bin/grav server --port=8080

# Start with custom host
bin/grav server --host=0.0.0.0

# Clear all caches
bin/grav cache --clear

# Clear specific cache types
bin/grav cache --clear-twig
bin/grav cache --clear-images
bin/grav cache --clear-assets
bin/grav cache --clear-plugins

# Clear without disabling site
bin/grav cache --clear --all

# Show cache status
bin/grav cache --status

# Install dependencies (Composer + plugins)
bin/grav install

# Install only Composer dependencies
bin/grav install --composer

# Install plugins only
bin/grav install --plugins

# Set up symlinks
bin/grav install --symlinks

# Create a new admin user (interactive)
bin/grav new-admin-user

# Create user with parameters
bin/grav new-admin-user --username=admin --email=admin@example.com

# List all users
bin/grav list-users

# Search for packages
bin/gpm search gallery
bin/gpm search "admin panel"

# Install a plugin
bin/gpm install admin
bin/gpm install form email login

# Install a specific version
bin/gpm install admin@1.10.0

# Install a theme
bin/gpm install quark

# Check for updates
bin/gpm check-updates

# Show all available updates
bin/gpm update --check

# Update all packages
bin/gpm update

# Update specific packages
bin/gpm update admin form

# Simulate update (dry run)
bin/gpm update --simulate

# Show installed packages
bin/gpm info admin

# List all installed plugins
bin/gpm list

# Show package details
bin/gpm show admin

# Check package dependencies
bin/gpm depends admin

# Remove a plugin
bin/gpm uninstall admin

# Remove without confirmation
bin/gpm uninstall admin --force

#!/bin/bash
set -e

BACKUP_DIR="/var/backups/grav"
SITE_DIR="/var/www/grav-site"
DATE=$(date +%Y-%m-%d-%H%M%S)

# Create backup directory
mkdir -p "$BACKUP_DIR/$DATE"

# Backup user data
echo "Backing up user data..."
tar -czf "$BACKUP_DIR/$DATE/user-data.tar.gz" \
    -C "$SITE_DIR" user/pages user/config user/accounts user/languages

# Check if user data backup succeeded
if [ $? -eq 0 ]; then
    echo "User data backup complete."
else
    echo "ERROR: User data backup failed!"
    exit 1
fi

# Export plugin list
echo "Exporting plugin list..."
bin/gpm list > "$BACKUP_DIR/$DATE/plugins.txt"

# Remove backups older than 30 days
find "$BACKUP_DIR" -type d -mtime +30 -exec rm -rf {} \;

echo "Backup complete: $BACKUP_DIR/$DATE"

#!/bin/bash

SITE_DIR="/var/www/grav-site"
cd "$SITE_DIR"

echo "Grav Health Check"
echo "================="

# Check PHP version
echo "PHP version: $(php -v | head -n1)"

# Check Grav version
echo "Grav version: $(php bin/grav version 2>&1)"

# Check cache status
php bin/grav cache --status

# Check for updates
php bin/gpm check-updates

# Check directory permissions
echo ""
echo "Checking permissions..."
for dir in user/data user/accounts user/config; do
    if [ -w "$SITE_DIR/$dir" ]; then
        echo "  $dir: writable"
    else
        echo "  $dir: NOT writable!"
    fi
done

# Check disk space
echo ""
echo "Disk usage:"
df -h /var/www | tail -n1

# Check PHP extensions
echo ""
echo "Required PHP extensions:"
for ext in curl mbstring xml zip gd json; do
    if php -m | grep -q "^$ext$"; then
        echo "  $ext: installed"
    else
        echo "  $ext: MISSING!"
    fi
done

// user/plugins/myadmin/myadmin.php
public function onCliInit()
{
    $this->grav['cli']->addCommand(
        new \Grav\Plugin\Console\HealthCheckCommand()
    );
    $this->grav['cli']->addCommand(
        new \Grav\Plugin\Console\SitemapGenerateCommand()
    );
}

<?php
namespace Grav\Plugin\Console;

use Grav\Console\ConsoleCommand;

class SitemapGenerateCommand extends ConsoleCommand
{
    protected function configure()
    {
        $this
            ->setName('sitemap:generate')
            ->setDescription('Generate XML sitemap')
            ->addOption(
                'pretty',
                'p',
                \Symfony\Component\Console\Input\InputOption::VALUE_NONE,
                'Pretty-print the XML'
            );
    }

    protected function serve($input, $output)
    {
        $this->setupConsole($input, $output);
        $io = $this->getIO();

        $io->title('Sitemap Generator');

        $pages = $this->grav['pages']->all();
        $xml = '<?xml version="1.0" encoding="UTF-8"?>' . "\n";
        $xml .= '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">' . "\n";

        $io->progressStart(count($pages));

        foreach ($pages as $page) {
            if ($page->published() && !$page->isModule()) {
                $xml .= '  <url>' . "\n";
                $xml .= '    <loc>' . $page->url(true) . '</loc>' . "\n";
                $xml .= '    <lastmod>' . date('c', $page->modified()) . '</lastmod>' . "\n";
                $xml .= '    <priority>' . ($page->route() == '/' ? '1.0' : '0.8') . '</priority>' . "\n";
                $xml .= '  </url>' . "\n";
            }
            $io->progressAdvance();
        }

        $xml .= '</urlset>' . "\n";

        file_put_contents(GRAV_ROOT . '/sitemap.xml', $xml);
        $io->progressFinish();
        $io->success('Sitemap generated: ' . GRAV_ROOT . '/sitemap.xml');
    }
}

# Edit crontab
crontab -e

# Add tasks
# Clear cache daily at 4 AM
0 4 * * * /usr/bin/php /var/www/grav/bin/grav cache --clear >> /var/log/grav-cache.log

# Run backup nightly at 2 AM
0 2 * * * /var/www/grav/scripts/backup.sh >> /var/log/grav-backup.log

# Health check every hour
0 * * * * /var/www/grav/scripts/health-check.sh >> /var/log/grav-health.log

# Check for updates weekly
0 6 * * 1 /usr/bin/php /var/www/grav/bin/gpm check-updates >> /var/log/grav-updates.log