CLI
xvii — один бинарник для всей платформы. Каждый сервис добавляет свою группу команд; CLI также выполняет
вход, разделяет несколько инстансов, дополняет имена и обновляет сам себя.
curl -fsSL https://xvii.network/install.sh | sh
xvii login xvii.network
xvii help
Группы команд
| Группа |
Команды |
| Сервисы |
pages, apps, env, notify, tunnel, hooks, ai, share, config |
| Рабочее пространство |
teams, projects |
| Аккаунт |
login, logout, whoami, tokens |
| Инстанс |
server install, server restore |
| Сам CLI |
context, completion, update, mcp, version, help |
Каждая команда с флагами и примерами есть в справочнике, а в терминале — в
xvii help <команда>.
Контексты
Контекст — это один инстанс (его домен) с выполненным на нём входом. xvii login DOMAIN создаёт контекст;
контексты хранятся в contexts.json (права 600) в папке настроек пользователя: ~/Library/Application Support/xvii на macOS, ~/.config/xvii на Linux.
xvii context # список; ● — текущий
xvii context add example.com --name work
xvii context use work
xvii --context work pages list # одна команда на другом инстансе
xvii context rm work
Переменные окружения
| Переменная |
Что делает |
XVII_DOMAIN, XVII_TOKEN |
инстанс и API-токен вместо сохранённого контекста (CI) |
XVII_CONTEXT |
какой сохранённый контекст использовать |
XVII_PROJECT, XVII_ENV |
значения по умолчанию для --project и --env в командах env и config |
XVII_<SERVICE>_URL |
другой адрес для одного сервиса (локальная разработка) |
XVII_NO_UPDATE_CHECK=1 |
не проверять обновления раз в день |
NO_COLOR |
без цветов |
В GitLab CI и GitHub Actions CLI также находит OIDC-токен задачи и обменивает его через правило доверия; см.
Деплой из CI.
Вывод для скриптов
Команды, которые выводят данные, принимают --json:
xvii pages list --json | jq -r '.[0].url'
xvii apps ls --json
Цвета появляются только в терминале. Ошибки идут в stderr одной строкой с подсказкой, код выхода — 1. Секреты,
которые показываются один раз (tokens create, ai keys create), выводятся в stdout отдельно, так что их
можно перехватить.
Автодополнение
xvii completion --install # для $SHELL
xvii completion fish > ~/.config/fish/completions/xvii.fish
Дополняются команды и флаги, а также имена с инстанса: алиасы, деплои, приложения, проекты, команды,
эндпоинты.
Обновления
xvii update ставит версию, которую предлагает текущий инстанс (с проверкой SHA-256); --check только
говорит, есть ли она. Остальные команды раз в день сообщают о новой версии.