Перейти к содержимому
WebShield Docs

Клиент командной строки (CLI)

Установка и использование CLI webshield — управление доменами, DNS-записями, настройками edge и публикация статических сайтов из терминала и CI.

webshield — официальный клиент командной строки для API WebShield. Он управляет доменами и DNS-записями, настройками проксируемых хостов, публикует статические сайты (включая инкрементальную публикацию из CI), показывает статистику и потребление.

Исходный код и релизы: github.com/webshieldpro/webshield-cli.

Установщик определяет ОС и архитектуру, скачивает последний релиз, проверяет контрольную сумму SHA-256 и устанавливает бинарный файл в ~/.local/bin:

Terminal window
curl -fsSL https://raw.githubusercontent.com/webshieldpro/webshield-cli/main/install.sh | sh

Готовые сборки для Linux (x86_64, aarch64 — статические, без зависимостей) и Windows доступны на странице релизов. Также можно собрать из исходного кода при наличии Rust:

Terminal window
git clone https://github.com/webshieldpro/webshield-cli
cd webshield-cli
cargo build --release
mv target/release/webshield ~/.local/bin/

Скрипты автодополнения вложены в каждый релизный архив; бинарный файл также генерирует их для bash, zsh, fish, PowerShell, elvish и nushell:

Terminal window
# bash
webshield completion bash > ~/.local/share/bash-completion/completions/webshield
# zsh (каталог должен быть в $fpath)
webshield completion zsh > ~/.zfunc/_webshield
# fish
webshield completion fish > ~/.config/fish/completions/webshield.fish

Для работы автодополнения в bash у вас в системе должен быть установлен пакет bash-completion.

CLI использует персональный API-токен (wsk_…). Создайте его в личном кабинете в разделе Настройки → API-токены с нужными правами — см. API-токены. Для CI рекомендуется узкий токен, привязанный к одному домену или сайту.

Terminal window
webshield auth login # запросит токен и сохранит его в профиль
webshield auth status # покажет активный профиль и проверит доступ

Другие способы передать токен: флаг --token или переменная окружения WS_TOKEN (удобно в CI). Профили хранятся в ~/.config/webshield/config.toml; поддерживается несколько профилей через --profile (или WS_PROFILE) — как в aws или gh.

Terminal window
webshield domains list # список доменов и статус делегирования
webshield domains add example.com # добавить домен (существующие записи импортируются сканированием)
webshield domains add example.com --import none
webshield domains check example.com # проверить делегирование на NS WebShield
webshield domains remove example.com

Домен остаётся у вашего DNS-провайдера, а имена подключаются записями (подробности — Подключение без смены NS):

Terminal window
webshield domains add example.com --external
webshield hosts add www.example.com --domain example.com --origin 203.0.113.10 # покажет записи
webshield hosts verify www.example.com # после записи _acme-challenge: подтверждение и сертификат
webshield hosts list # статус, сертификат, идёт ли трафик
webshield hosts records www.example.com # записи ещё раз
webshield hosts add blog.example.com --domain example.com --mode static
webshield proxy set www.example.com --domain example.com --origin 203.0.113.20 # сменить сервер
webshield hosts remove www.example.com
Terminal window
webshield dns list example.com
webshield dns list example.com --type A
webshield dns add example.com www A 203.0.113.10 # добавить значение в набор
webshield dns set example.com @ A 203.0.113.10 # сделать набор ровно таким
webshield dns remove example.com www A 203.0.113.10 # удалить одно значение
webshield dns remove example.com www TXT # удалить весь набор записей
webshield dns add example.com www CNAME foo.example.com # точка в конце добавляется автоматически
webshield dns add example.com @ MX "10 mail.example.com" --ttl 3600

Семантика для многозначных типов (A, AAAA, TXT, MX): add добавляет значения к существующему набору, set делает набор ровно равным указанным значениям, remove удаляет только перечисленные значения (без значений — весь набор). CNAME/NS одиночные и всегда заменяются целиком.

Terminal window
webshield dns dnssec status example.com # DS-записи для регистратора
webshield dns dnssec enable example.com
webshield dns dnssec disable example.com # заблокировано, пока DS виден в родительской зоне

Шаги на стороне регистратора — см. DNSSEC.

Terminal window
webshield apps list
webshield apps deploy --project shop --app web # упаковать каталог, загрузить, дождаться запуска
webshield apps deploy --url https://example.com/app.tar.gz --project shop --app web
webshield apps deployments --project shop --app web
webshield apps redeploy 42 # откат на выкатку #42
webshield apps logs --project shop --app web -f # журнал с новыми строками
webshield apps db create db --size 2 # база Postgres в проекте
webshield apps db restore db --as db2 --time 2026-10-21T15:00:00+03:00 # в новую базу; без --time — последнее состояние
webshield apps kv create cache --memory 128 # хранилище Valkey
webshield apps env set DATABASE_URL='${{db.url}}' REDIS_URL='${{cache.url}}' --redeploy
printf %s "$STRIPE_KEY" | webshield apps env set STRIPE_KEY # значение из stdin
webshield apps env list # только имена; со значениями — --values
webshield apps env unset OLD_FLAG
webshield apps db list; webshield apps kv delete cache
webshield apps d1 migrate --app api app-db # функция: миграции D1 из каталога проекта
webshield apps d1 execute --app api app-db --command "SELECT 1"
webshield apps kv import --app api CACHE keys.json # ключи KV функции, формат bulk у Wrangler
webshield apps window --app api # с какого момента можно вернуть данные функции
webshield apps restore --app api --time 2026-10-21T15:00:00+03:00
webshield apps operations --app api # последние операции с данными функции
webshield apps balance # доступный остаток и цены
webshield apps usage --project shop # расходы проекта за месяц по дням
webshield apps cap 500 --project shop # потолок в месяц; off — снять

Имена можно не писать: команды берут проект и приложение из webshield.toml в каталоге (--dir, по умолчанию текущий). Ссылку ${{…}} берите в одинарные кавычки — иначе оболочка попробует подставить её сама. Без --redeploy переменные вступят в силу со следующей выкатки. deploy ждёт запуска и при ошибке завершается с ненулевым кодом. Подробнее — Приложения и Функции, выкатка из CI — руководство.

Terminal window
webshield sites list
webshield sites create www.example.com --domain example.com
webshield sites publish www.example.com --dir ./public # инкрементальная публикация
webshield sites publish --site-id 6 --dir ./public # по id (для узких токенов sites:publish)
webshield sites publish www.example.com --dir ./public --dry-run # только показать план
webshield sites publish-from-bucket www.example.com --bucket web --path public/ # из вашего S3-бакета
webshield sites files www.example.com

publish-from-bucket публикует сайт прямо из одного из ваших бакетов объектного хранилища (сначала залейте туда сайт любым S3-инструментом). Команда запускает асинхронную публикацию и ждёт её завершения.

publish вычисляет разницу с сервером (по хешу содержимого), загружает только изменённые файлы, удаляет исчезнувшие и атомарно публикует новую версию — безопасно запускать из CI на каждую сборку.

Минимальный шаг для GitHub Actions (Gitea Actions, Forgejo Actions):

- name: Publish site
env:
WS_TOKEN: ${{ secrets.WS_PUBLISH_TOKEN }}
run: |
curl -fsSL https://raw.githubusercontent.com/webshieldpro/webshield-cli/main/install.sh | sh
~/.local/bin/webshield sites publish www.example.com --dir ./public

То же задание для GitLab CI (WS_TOKEN — переменная CI/CD с галочками Masked и Protected):

publish:
script:
- curl -fsSL https://raw.githubusercontent.com/webshieldpro/webshield-cli/main/install.sh | sh
- ~/.local/bin/webshield sites publish www.example.com --dir ./public

Подробнее о режимах размещения и токенах для CI — Размещение статического сайта.

Terminal window
webshield proxy list
webshield proxy get app.example.com
webshield proxy set app.example.com --domain example.com --ssl true --bot-protection true
webshield proxy set old.example.com --domain example.com \
--mode redirect --redirect-target example.com
webshield proxy set shop.example.com --domain example.com --html-cache true
webshield proxy purge-cache app.example.com
webshield proxy remove app.example.com

proxy set создаёт конфигурацию хоста или частично обновляет существующую; булевы флаги отправляются только при явном указании, остальные настройки не затрагиваются.

purge-cache сбрасывает всё, что мы закешировали для хоста, — пригодится в конце деплоя, если файлы обновились под прежними именами. Подробнее — CDN и защита.

Terminal window
webshield stats summary example.com --range 7d # сводка трафика и запросов
webshield stats bans example.com # активные баны и проверки
webshield billing balance
webshield billing usage example.com # трафик относительно лимита тарифа
webshield billing tariffs example.com

Каждая команда поддерживает машиночитаемый вывод:

Terminal window
webshield -o json domains list | jq -r '.[].name'

Язык интерфейса выбирается флагом --lang en|ru (или WS_LANG); по умолчанию — системная локаль. Флаг --yes отключает запросы подтверждения для необратимых операций.