--- metadata: - name: generator content: Diplodoc Platform v5.56.0 alternate: - https://3y3.dev/en/tools/docs/portable.md - https://3y3.dev/ru/tools/docs/portable.md - href: ru/tools/docs/portable.md type: text/markdown title: Markdown version - href: ../../llms.txt type: text/markdown title: llms.txt updatedAt: '2026-08-24T14:58:23.000Z' --- > **Documentation Index:** Fetch the complete configuration index at https://3y3.dev/ru/llms.txt # Portable-версия CLI Из пакета [@diplodoc/cli](https://www.npmjs.com/package/@diplodoc/cli) можно собрать один исполняемый файл для Windows, macOS или Linux. Внутри такого файла уже есть и сам CLI, и среда выполнения Node.js, поэтому на компьютере, где он запускается, не нужно ничего устанавливать: ни Node.js, ни npm. Интернет для работы тоже не требуется. Это удобно, если документацию собирают люди без прав на установку программ или на компьютерах без доступа в интернет. {% note info %} Сборку достаточно выполнить один раз на любом компьютере с интернетом. Готовый файл можно просто копировать на другие машины с той же операционной системой. {% endnote %} ## Шаг 1. Установите Node.js {#install-node} Node.js нужен только на том компьютере, где вы собираете файл. 1. Скачайте установщик Node.js версии 24 или новее с [официального сайта](https://nodejs.org/). 2. Запустите его и пройдите все шаги с настройками по умолчанию. 3. Откройте терминал (в Windows - приложение **PowerShell**) и проверьте установку: ```shell node -v ``` В ответ должен появиться номер версии, например `v24.18.0`. ## Шаг 2. Соберите исполняемый файл {#build} Выберите вкладку с системой, на которой будет работать файл. Скопируйте блок в терминал целиком и нажмите Enter: он создаст папку `yfm-exe`, скачает в нее нужные пакеты и соберет файл. {% list tabs %} - Windows Выполните в **PowerShell**: ```powershell mkdir yfm-exe cd yfm-exe @' { "name": "yfm-portable", "version": "1.0.0", "bin": "node_modules/@diplodoc/cli/build/index.js", "pkg": { "scripts": [ "node_modules/@diplodoc/cli/build/**/*.js", "node_modules/@diplodoc/cli/lib/**/*.js", "node_modules/@diplodoc/client/build/server/**/*.js" ], "assets": [ "node_modules/@diplodoc/cli/assets/**/*", "node_modules/@diplodoc/cli/build/manifest.json", "node_modules/@diplodoc/cli/package.json", "node_modules/highlight.js/styles/**/*" ] } } '@ | Set-Content -Encoding Ascii package.json npm install @diplodoc/cli @yao-pkg/pkg npx pkg --compress GZip --public -t node24-win-x64 -o dist/yfm.exe package.json ``` Готовый файл: `yfm-exe/dist/yfm.exe`. - macOS Выполните в Терминале: ```shell mkdir yfm-exe && cd yfm-exe cat > package.json <<'EOF' { "name": "yfm-portable", "version": "1.0.0", "bin": "node_modules/@diplodoc/cli/build/index.js", "pkg": { "scripts": [ "node_modules/@diplodoc/cli/build/**/*.js", "node_modules/@diplodoc/cli/lib/**/*.js", "node_modules/@diplodoc/client/build/server/**/*.js" ], "assets": [ "node_modules/@diplodoc/cli/assets/**/*", "node_modules/@diplodoc/cli/build/manifest.json", "node_modules/@diplodoc/cli/package.json", "node_modules/highlight.js/styles/**/*" ] } } EOF npm install @diplodoc/cli @yao-pkg/pkg npx pkg --compress GZip --public -t node24-macos-arm64 -o dist/yfm package.json ``` Готовый файл: `yfm-exe/dist/yfm`. {% note info %} Команда собирает файл для Mac с процессором Apple Silicon (M1 и новее). Для Mac на Intel замените в последней команде `node24-macos-arm64` на `node24-macos-x64`. {% endnote %} - Linux Выполните в терминале: ```shell mkdir yfm-exe && cd yfm-exe cat > package.json <<'EOF' { "name": "yfm-portable", "version": "1.0.0", "bin": "node_modules/@diplodoc/cli/build/index.js", "pkg": { "scripts": [ "node_modules/@diplodoc/cli/build/**/*.js", "node_modules/@diplodoc/cli/lib/**/*.js", "node_modules/@diplodoc/client/build/server/**/*.js" ], "assets": [ "node_modules/@diplodoc/cli/assets/**/*", "node_modules/@diplodoc/cli/build/manifest.json", "node_modules/@diplodoc/cli/package.json", "node_modules/highlight.js/styles/**/*" ] } } EOF npm install @diplodoc/cli @yao-pkg/pkg npx pkg --compress GZip --public -t node24-linux-x64 -o dist/yfm package.json ``` Готовый файл: `yfm-exe/dist/yfm`. {% note info %} Команда собирает файл для процессоров x64. Для arm64 (например, Raspberry Pi или серверы на ARM) замените в последней команде `node24-linux-x64` на `node24-linux-arm64`. {% endnote %} {% endlist %} Последняя команда при первом запуске скачивает базовую сборку Node.js для целевой системы, поэтому может работать несколько минут. Предупреждения `Warning` в процессе - это нормально. Размер готового файла - около 150 МБ: внутри лежит полноценный Node.js. {% cut "Что делает этот блок" %} 1. Создает папку `yfm-exe` и переходит в нее. 2. Кладет в нее файл `package.json` - список внутренних файлов CLI, которые нужно упаковать внутрь исполняемого файла. Без этого списка собранный файл не запустится. 3. Устанавливает два пакета: сам CLI и инструмент упаковки [@yao-pkg/pkg](https://github.com/yao-pkg/pkg). 4. Запускает упаковку: параметр `-t` задает целевую систему, `--compress GZip` уменьшает размер файла примерно вдвое, `-o` - путь к результату. {% endcut %} ## Шаг 3. Проверьте результат {#check} Запустите собранный файл. В Windows: ```shell dist\yfm.exe --version ``` В macOS и Linux: ```shell ./dist/yfm --version ``` В ответ должна появиться версия CLI, например `5.55.3`. Затем соберите какой-нибудь проект документации: ```shell dist\yfm.exe -i путь-к-исходникам -o путь-к-результату ``` ## Как пользоваться {#usage} * Скопируйте файл в любое место: на другой компьютер, флешку или сетевой диск. Установка не нужна, файл самодостаточен. * Все команды и параметры такие же, как у обычного `yfm` из npm: [сборка проекта](https://3y3.dev/ru/tools/docs/build.md), [параметры сборки](https://3y3.dev/ru/tools/docs/settings.md). * Файл не подписан, поэтому системы защиты могут спросить подтверждение при первом запуске: * в Windows нажмите в окне SmartScreen **Подробнее**, затем **Выполнить в любом случае**; * в macOS, если файл скачан из интернета, разрешите запуск в **Системных настройках** → **Конфиденциальность и безопасность**, либо снимите карантин командой `xattr -d com.apple.quarantine путь-к-файлу`. ## Ограничения {#limitations} * Файл работает только на той системе, для которой собран. Нужны и Windows, и macOS - соберите два файла, см. [сборку под другую систему](#other-targets). * Пользовательские плагины (файл `plugins.js` рядом с проектом) из portable-версии не подключаются. {% cut "Как вшить плагины внутрь файла" %} Плагины можно упаковать внутрь файла на этапе сборки. Перед последней командой шага 2 скопируйте файл с плагинами в пакет CLI: ```shell mkdir -p node_modules/@diplodoc/cli/build/plugins cp путь-к-вашему-plugins.js node_modules/@diplodoc/cli/build/plugins/index.js ``` После этого соберите файл заново - плагины будут работать на всех машинах без дополнительных файлов. {% endcut %} * Чтобы обновить CLI до новой версии, соберите файл заново: выполните в папке `yfm-exe` команду `npm install @diplodoc/cli@latest` и повторите последнюю команду [шага 2](#build). ## Сборка под другую систему {#other-targets} Собирать можно на одной системе, а запускать на другой: например, на macOS собрать файл для Windows. Для этого поменяйте в последней команде шага 2 значение параметра `-t`: | Система | Параметр `-t` | | --- | --- | | Windows x64 | `node24-win-x64` | | Windows arm64 | `node24-win-arm64` | | macOS Apple Silicon | `node24-macos-arm64` | | macOS Intel | `node24-macos-x64` | | Linux x64 | `node24-linux-x64` | | Linux arm64 | `node24-linux-arm64` | Например, сборка файла для Windows на любой системе: ```shell npx pkg --compress GZip --public -t node24-win-x64 -o dist/yfm.exe package.json ```