bundle-config - справочное руководство, опции, примеры команд

ИМЯ

bundle-config - Установить параметры конфигурации упаковщика

СИНТАКСИС

bundle config list
bundle config [get] NAME
bundle config [set] NAME VALUE
bundle config unset NAME

ОПИСАНИЕ

Эта команда позволяет вам взаимодействовать с системой конфигурации Bundler.

Bundler загружает параметры конфигурации в следующем порядке:

  1. Локальная конфигурация (/.bundle/config или $BUNDLE_APP_CONFIG/config)

  2. Переменные среды (ENV)

  3. Глобальная конфигурация (~/.bundle/config)

  4. Конфигурация бандлера по умолчанию

выполнение

bundle config list

напечатает список всех конфигураций сборщика для текущего пакета и где эта конфигурация была установлена.

выполнение

bundle config get <name>

напечатает значение этого параметра конфигурации и где он был установлен.

выполнение

bundle config set <name> <value>

по умолчанию устанавливается локальная конфигурация при выполнении из локального приложения, в противном случае устанавливается глобальная конфигурация. См. варианты --local и --global ниже.

выполнение

bundle config set --local <name> <value>

установит эту конфигурацию в каталоге для локального приложения. Конфигурация будет храниться в /.bundle/config. Если установлено BUNDLE_APP_CONFIG, конфигурация будет сохранена в $BUNDLE_APP_CONFIG/config.

выполнение

bundle config set --global <name> <value>

установит для этой конфигурации значение, указанное для всех пакетов, выполняемых от имени текущего пользователя. Конфигурация будет сохранена в ~/.bundle/config. Если имя уже задано, имя будет переопределено, и пользователь получит предупреждение.

выполнение

bundle config unset <name>

удалит конфигурацию как в локальных, так и в глобальных источниках.

выполнение

bundle config unset --global <name>

удалит конфигурацию только из пользовательской конфигурации.

выполнение

bundle config unset --local <name>

удалит конфигурацию только из локального приложения.

Выполнение пакета с набором переменных среды BUNDLE_IGNORE_CONFIG приведет к игнорированию всей конфигурации.

ЗАПОМНЕНИЕ ВАРИАНТОВ

Флаги, передаваемые bundle install или среде выполнения Bundler, такие как --path foo или --without production, запоминаются между командами и сохраняются в конфигурация вашего локального приложения (обычно ./.bundle/config).

Однако это будет изменено в сборщике 3, поэтому лучше не полагаться на такое поведение. Если эти параметры необходимо запомнить, лучше установить их с помощью конфигурации пакета (например, набор конфигурации пакета --local path foo).

Параметры, которые можно настроить, следующие:

bin

Создает каталог (по умолчанию ~/bin) и помещает туда все исполняемые файлы из драгоценного камня. Эти исполняемые файлы запускаются в контексте Bundler. Если он используется, вы можете добавить этот каталог в переменную PATH вашей среды. Например, если гем rails поставляется с исполняемым файлом rails, этот флаг создаст исполняемый файл bin/rails, который гарантирует, что все указанные зависимости будут быть решены с помощью связанных драгоценных камней.

deployment

В режиме развертывания Bundler «развернет» пакет для производственного использования. Внимательно проверьте, хотите ли вы включить этот параметр в средах разработки или тестирования.

only

Разделенный пробелами список групп для установки только гемов указанных групп.

path

Место для установки указанных гемов. По умолчанию используется настройка Rubygems. Bundler разделяет это расположение с Rubygems, gem install ... также будет иметь установленный там gem. Таким образом, gems, установленные без параметра --path..., будут отображаться при вызове gem list. Соответственно, драгоценные камни, установленные в других местах, не будут перечислены.

without

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

with

Разделенный пробелами список необязательных групп, ссылающихся на гемы, которые нужно включить во время установки.

ВАРИАНТЫ ПОСТРОЕНИЯ

Вы можете использовать bundle config, чтобы дать Bundler флаги для передачи установщику gem каждый раз, когда бандлер пытается установить определенный gem.

Очень распространенный пример, гем mysql, требует, чтобы пользователи Snow Leopard передали флаги конфигурации в gem install, чтобы указать, где найти исполняемый файл mysql_config.

gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config

Поскольку конкретное расположение этого исполняемого файла может меняться от машины к машине, вы можете указать эти флаги для каждой машины отдельно.

bundle config set --global build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config

После запуска этой команды каждый раз, когда сборщику необходимо установить гем mysql, он будет передавать указанные вами флаги.

КЛЮЧИ КОНФИГУРАЦИИ

Ключи конфигурации в сборщике имеют две формы: каноническую форму и форму переменной среды.

Например, передача флага --without в команду bundle install(1) bundle-install.1.html запрещает Bundler устанавливать определенные группы, указанные в Gemfile(5). Bundler сохраняет это значение в app/.bundle/config, чтобы вызовы Bundler.setup не пытались найти драгоценные камни из Gemfile, который вы не устанавливал. Кроме того, последующие вызовы bundle install(1) bundle-install.1.html запоминают этот параметр и пропускают эти группы.

Каноническая форма этой конфигурации — "без". Чтобы преобразовать каноническую форму в форму переменной среды, начните ее с заглавной буквы и добавьте BUNDLE_. Форма переменной среды без — BUNDLE_WITHOUT.

Любые точки в ключах конфигурации должны быть заменены двумя символами подчеркивания при установке через переменные среды. Ключ конфигурации local.rack становится переменной среды BUNDLE_LOCAL__RACK.

СПИСОК ДОСТУПНЫХ КЛЮЧЕЙ

Ниже приведен список всех ключей конфигурации и их назначение. Вы можете узнать больше об их работе в пакетной установке(1) bundle-install.1.html.

allow_deployment_source_credential_changes (BUNDLE_ALLOW_DEPLOYMENT_SOURCE_CREDENTIAL_CHANGES)

В режиме развертывания разрешите изменение учетных данных на источник драгоценного камня. Пример: https://some.host.com/gems/path/ -> https://user_name:password@some.host.com/gems/path

allow_offline_install (BUNDLE_ALLOW_OFFLINE_INSTALL)

Разрешить Bundler использовать кэшированные данные при установке без доступа к сети.

auto_clean_without_path (BUNDLE_AUTO_CLEAN_WITHOUT_PATH)

Автоматически запускать bundle clean после установки, если не задан явный путь и Bundler не устанавливается в системные гемы.

auto_install (BUNDLE_AUTO_INSTALL)

Автоматически запускать установку пакета при отсутствии драгоценных камней.

bin (BUNDLE_BIN)

Установите исполняемые файлы из драгоценных камней в комплекте в указанный каталог. По умолчанию false.

cache_all (BUNDLE_CACHE_ALL)

Кэшировать все гемы, включая гемы path и git. Это должно быть явно настроено для сборщика 1 и сборщика 2, но будет использоваться по умолчанию для сборщика 3.

cache_all_platforms (BUNDLE_CACHE_ALL_PLATFORMS)

Кэшируйте драгоценные камни для всех платформ.

cache_path (BUNDLE_CACHE_PATH)

Каталог, в который упаковщик будет помещать кэшированные драгоценные камни при запуске пакета сборки, и этот упаковщик будет искать его при установке драгоценных камней. По умолчанию используется vendor/cache.

clean (BUNDLE_CLEAN)

Должен ли Bundler запускать очистку пакета автоматически после установки пакета.

console (BUNDLE_CONSOLE)

Консоль, с которой запускается консоль объединения. По умолчанию используется irb.

default_install_uses_path (BUNDLE_DEFAULT_INSTALL_USES_PATH)

Будет ли установка пакета без явного аргумента --path по умолчанию устанавливать драгоценные камни в .bundle.

deployment (BUNDLE_DEPLOYMENT)

Запретить изменения в Gemfile. Когда Gemfile изменен, а файл блокировки не обновлен, выполнение команд Bundler будет заблокировано.

disable_checksum_validation (BUNDLE_DISABLE_CHECKSUM_VALIDATION)

Разрешить установку гемов, даже если они не соответствуют контрольной сумме, предоставленной RubyGems.

disable_exec_load (BUNDLE_DISABLE_EXEC_LOAD)

Не позволяйте Bundler использовать load для запуска исполняемого файла в процессе bundle exec.

disable_local_branch_check (BUNDLE_DISABLE_LOCAL_BRANCH_CHECK)

Разрешить Bundler использовать локальное переопределение git без ветки, указанной в Gemfile.

disable_local_revision_check (BUNDLE_DISABLE_LOCAL_REVISION_CHECK)

Разрешить Bundler использовать локальное переопределение git, не проверяя, присутствует ли ревизия, присутствующая в файле блокировки, в репозитории.

disable_shared_gems (BUNDLE_DISABLE_SHARED_GEMS)

Не позволяйте Bundler получать доступ к драгоценным камням, установленным в обычном местоположении RubyGems.

disable_version_check (BUNDLE_DISABLE_VERSION_CHECK)

Не позволяйте Bundler проверять, доступна ли более новая версия Bundler на rubygems.org.

force_ruby_platform (BUNDLE_FORCE_RUBY_PLATFORM)

Игнорируйте платформу текущего компьютера и устанавливайте только ruby драгоценные камни платформы. В результате гемы с нативными расширениями будут скомпилированы из исходников.

frozen (BUNDLE_FROZEN)

Запретить изменения в Gemfile. Когда Gemfile изменен, а файл блокировки не обновлен, выполнение команд Bundler будет заблокировано. По умолчанию используется значение true, когда используется --deployment.

gem.github_username (BUNDLE_GEM__GITHUB_USERNAME)

Устанавливает имя пользователя или организацию GitHub, которые будут использоваться в файле README при создании нового гема с помощью команды bundle gem. Его можно переопределить, передав явный флаг --github-username в bundle gem.

gem.push_key (BUNDLE_GEM__PUSH_KEY)

Устанавливает параметр --key для gem push при использовании команды rake release с частным сервером gemstash.

gemfile (BUNDLE_GEMFILE)

Имя файла, который упаковщик должен использовать в качестве Gemfile. Это расположение этого файла также устанавливает корень проекта, который используется, среди прочего, для разрешения относительных путей в Gemfile. По умолчанию упаковщик будет искать в текущем рабочем каталоге, пока не найдет Gemfile.

global_gem_cache (BUNDLE_GLOBAL_GEM_CACHE)

Должен ли Bundler кэшировать все драгоценные камни глобально, а не локально для установки установки Ruby.

ignore_funding_requests (BUNDLE_IGNORE_FUNDING_REQUESTS)

Когда установлено, никакие запросы на финансирование не будут распечатаны.

ignore_messages (BUNDLE_IGNORE_MESSAGES)

Если установлено, сообщения после установки не печатаются. Чтобы отключить один драгоценный камень, используйте запись через точку, например ignore_messages.httparty true.

init_gems_rb (BUNDLE_INIT_GEMS_RB)

Создайте gems.rb вместо Gemfile при запуске bundle init.

jobs (BUNDLE_JOBS)

Количество драгоценных камней, которые Bundler может установить параллельно. По умолчанию количество доступных процессоров.

no_install (BUNDLE_NO_INSTALL)

Должен ли комплектный пакет пропускать установку гемов.

no_prune (BUNDLE_NO_PRUNE)

Должен ли Bundler оставлять устаревшие драгоценные камни необрезанными при кэшировании.

only (BUNDLE_ONLY)

Разделенный пробелами список групп для установки только гемов указанных групп.

path (BUNDLE_PATH)

Место на диске, где будут располагаться все драгоценные камни в вашем комплекте, независимо от значений $GEM_HOME или $GEM_PATH. Пакетные драгоценные камни, не найденные в этом месте, будут установлены с помощью установки пакета. По умолчанию используется Gem.dir. Когда используется --deployment, по умолчанию используется vendor/bundle.

path.system (BUNDLE_PATH__SYSTEM)

Будет ли Bundler устанавливать драгоценные камни в системный путь по умолчанию (Gem.dir).

path_relative_to_cwd (BUNDLE_PATH_RELATIVE_TO_CWD)

Делает --path относительно CWD вместо Gemfile.

plugins (BUNDLE_PLUGINS)

Включите экспериментальную систему плагинов Bundler.

prefer_patch (BUNDLE_PREFER_PATCH)

Предпочитайте обновление только до следующей версии исправления во время обновлений. Делает вызовы bundle update эквивалентными bundle update --patch.

print_only_version_number (BUNDLE_PRINT_ONLY_VERSION_NUMBER)

Вывести только номер версии из bundler --version.

redirect (BUNDLE_REDIRECT)

Количество перенаправлений, разрешенных для сетевых запросов. По умолчанию 5.

retry (BUNDLE_RETRY)

Количество повторных неудачных сетевых запросов. По умолчанию 3.

setup_makes_kernel_gem_public (BUNDLE_SETUP_MAKES_KERNEL_GEM_PUBLIC)

Попросите Bundler.setup сделать метод Kernel#gem общедоступным, даже если RubyGems объявляет его закрытым.

shebang (BUNDLE_SHEBANG)

Имя программы, которая должна вызываться для сгенерированных binstub. По умолчанию используется имя установки ruby, используемое для создания binstub.

silence_deprecations (BUNDLE_SILENCE_DEPRECATIONS)

Должен ли Bundler отключать предупреждения об устаревании для поведения, которое будет изменено в следующей основной версии.

silence_root_warning (BUNDLE_SILENCE_ROOT_WARNING)

Отключите предупреждение, которое Bundler печатает при установке драгоценных камней с правами root.

ssl_ca_cert (BUNDLE_SSL_CA_CERT)

Путь к назначенному файлу сертификата ЦС или папке, содержащей несколько сертификатов для доверенных ЦС в формате PEM.

ssl_client_cert (BUNDLE_SSL_CLIENT_CERT)

Путь к назначенному файлу, содержащему сертификат клиента X.509 и ключ в формате PEM.

ssl_verify_mode (BUNDLE_SSL_VERIFY_MODE)

Режим проверки SSL, который Bundler использует при отправке HTTPS-запросов. По умолчанию для проверки пира.

suppress_install_using_messages (BUNDLE_SUPPRESS_INSTALL_USING_MESSAGES)

Избегайте вывода сообщений Using... во время установки, если версия гема не изменилась.

system_bindir (BUNDLE_SYSTEM_BINDIR)

Место, куда RubyGems устанавливает binstubs. По умолчанию используется Gem.bindir.

timeout (BUNDLE_TIMEOUT)

Количество секунд, разрешенных до истечения времени ожидания для сетевых запросов. По умолчанию 10.

update_requires_all_flag (BUNDLE_UPDATE_REQUIRES_ALL_FLAG)

Требовать передачи --all в обновление пакета, когда все должно быть обновлено, и запретить передачу параметров в обновление пакета.

user_agent (BUNDLE_USER_AGENT)

Фрагмент пользовательского агента Bundler включает в запросы API.

with (BUNDLE_WITH)

Разделенный : список групп, для которых должен быть установлен сборщик gems.

without (BUNDLE_WITHOUT)

Разделенный : список групп, сборщик gems которых не должен устанавливать.

Как правило, эти параметры следует устанавливать для каждого приложения с помощью соответствующего флага для пакета install(1) bundle-install.1.html или пакета cache(1) bundle-cache. 1.html команда.

Вы можете установить их глобально либо через переменные среды, либо через конфигурацию пакета, в зависимости от того, что предпочтительнее для вашей настройки. Если вы используете оба варианта, переменные окружения будут иметь преимущество перед глобальными параметрами.

ЛОКАЛЬНЫЕ РЕПО GIT

Bundler также позволяет вам работать с репозиторием git локально вместо использования удаленной версии. Этого можно добиться, настроив локальное переопределение:

bundle config set --local local.GEM_NAME /path/to/local/git/repository

Например, чтобы использовать локальный репозиторий Rack, разработчик может вызвать:

bundle config set --local local.rack ~/Work/git/rack

Теперь вместо проверки удаленного репозитория git будет использоваться локальное переопределение. Подобно источнику пути, каждый раз, когда изменяется локальный репозиторий git, Bundler автоматически принимает изменения. Это означает, что фиксация в локальном репозитории git обновит версию в Gemfile.lock до версии локального репозитория git. Это требует такого же внимания, как и подмодули git. Перед отправкой на удаленный сервер необходимо убедиться, что локальное переопределение было отправлено, иначе вы можете указать на фиксацию, которая существует только на вашем локальном компьютере. Вам также потребуется CGI экранировать ваши имена пользователей и пароли.

Bundler выполняет множество проверок, чтобы гарантировать, что разработчик не будет работать с недействительными ссылками. В частности, мы заставляем разработчика указывать ветку в Gemfile, чтобы использовать эту функцию. Если ветка, указанная в Gemfile, и текущая ветка в локальном репозитории git не совпадают, Bundler прервется. Это гарантирует, что разработчик всегда работает с правильными ветвями, и предотвращает случайную блокировку другой ветки.

Наконец, Bundler также гарантирует, что текущая версия в Gemfile.lock существует в локальном репозитории git. Делая это, Bundler заставляет вас получать последние изменения в пультах.

ЗЕРКАЛА ИСТОЧНИКОВ ДРАГОЦЕННЫХ КАМЕНИЙ

Bundler поддерживает переопределение источников драгоценных камней с помощью зеркал. Это позволяет вам настроить rubygems.org в качестве источника драгоценных камней в вашем Gemfile, в то же время используя свое зеркало для извлечения драгоценных камней.

bundle config set --global mirror.SOURCE_URL MIRROR_URL

Например, чтобы использовать зеркало https://rubygems.org, размещенное по адресу https://example.org:

bundle config set --global mirror.https://rubygems.org https://example.org

Каждое зеркало также предоставляет настройку тайм-аута резервного копирования. Если зеркало не отвечает в течение резервного тайм-аута, Bundler попытается использовать исходный сервер вместо зеркала.

bundle config set --global mirror.SOURCE_URL.fallback_timeout TIMEOUT

Например, чтобы вернуться к rubygems.org через 3 секунды:

bundle config set --global mirror.https://rubygems.org.fallback_timeout 3

Время ожидания возврата по умолчанию составляет 0,1 секунды, но в настоящее время этот параметр может принимать только целые секунды (например, 1, 15 или 30).

ПОЛНОМОЧИЯ ДЛЯ ИСТОЧНИКОВ драгоценных камней

Bundler позволяет вам настроить учетные данные для любого источника драгоценных камней, что позволяет вам не помещать секреты в ваш Gemfile.

bundle config set --global SOURCE_HOSTNAME USERNAME:PASSWORD

Например, чтобы сохранить учетные данные пользователя claudette для источника драгоценного камня на gems.longerous.com, вы должны запустить:

bundle config set --global gems.longerous.com claudette:s00pers3krit

Или вы можете установить учетные данные в качестве переменной среды следующим образом:

export BUNDLE_GEMS__LONGEROUS__COM="claudette:s00pers3krit"

Для драгоценных камней с источником git с URL-адресом HTTP (S) вы можете указать учетные данные следующим образом:

bundle config set --global https://github.com/rubygems/rubygems.git username:password

Или вы можете установить учетные данные в качестве переменной среды следующим образом:

export BUNDLE_GITHUB__COM=username:password

Это особенно полезно для частных репозиториев на хостах, таких как GitHub, где вы можете использовать личные токены OAuth:

export BUNDLE_GITHUB__COM=abcd0123generatedtoken:x-oauth-basic

Обратите внимание, что любые настроенные учетные данные будут отредактированы информативными командами, такими как bundle config list или bundle config get, если вы не используете флаг --parseable. . Это делается для того, чтобы избежать непреднамеренной утечки учетных данных при копировании и вставке выходных данных упаковщика.

Также обратите внимание, что для обеспечения нормального сопоставления между допустимыми именами переменных среды и допустимыми именами хостов упаковщик выполняет следующие преобразования:

-
.

Любые эти символы в имени хоста сопоставляются с двойным тире (__) в соответствующей переменной среды.

Это означает, что если у вас есть сервер gem с именем my.gem-host.com, вам потребуется использовать переменную BUNDLE_MY__GEM___HOST__COM для настройки учетных данных для него через ENV.

НАСТРОЙКА КАТАЛОГА ОБЪЕДИНИТЕЛЯ

Каталоги home, config, cache и plugin могут быть настроены с помощью переменных среды. Расположение по умолчанию для домашнего каталога Bundler — ~/.bundle, от которого по умолчанию наследуются все каталоги. Ниже описаны доступные переменные среды и их значения по умолчанию.

BUNDLE_USER_HOME : $HOME/.bundle
BUNDLE_USER_CACHE : $BUNDLE_USER_HOME/cache
BUNDLE_USER_CONFIG : $BUNDLE_USER_HOME/config
BUNDLE_USER_PLUGIN : $BUNDLE_USER_HOME/plugin