{"componentChunkName":"component---src-templates-plugin-documentation-jsx","path":"/custom-tools-plugin/","result":{"data":{"jenkinsPlugin":{"id":"6e897518-2494-5b2a-9089-c1677aba14a5","gav":"com.cloudbees.jenkins.plugins:custom-tools-plugin:0.8","hasBomEntry":false,"title":"Custom Tools","url":"https://updates.jenkins.io/download/plugins/custom-tools-plugin/0.8/custom-tools-plugin.hpi","version":"0.8","wiki":{"childHtmlRehype":{"html":"
\n
\n
\n \n
\n

\"Jenkins \"GitHub \"Jenkins

\n

A generic tool installer. You define how tools get installed, and the plugin will automatically install them when needed.

\n
\n

Overview

\n \n
\n

A job will often require a tool not already installed on your Jenkins agents. In large environments, this often results in waiting on an administrator. The goal of this plugin is to let users manage their own tools, without requiring this administrator involvement.

\n

Using this plugin, you can define a script (or just a URL) for installing a tool using standard Jenkins Tool Installers. Plugins like Extra Tool Installers can be also used in this plugin. You then define which jobs require the tool, and the plugin installs them as needed before the build runs.

\n
\n

Changelog

\n \n
\n \n
\n

Usage

\n \n
\n
\n

Defining tools

\n \n
\n

Let's say that you have a build that needs NodeJS. It is possible to use a NodeJS Plugin for it, but we will use it as an example.

\n
    \n
  1. Go to the Manage Jenkins > Global Tool Configuration page and to find the Custom Tool section there.
    2. \n
  2. Add a new NodeJS Tool
    3. \n
  3. Configure the tool installer. E.g. you can use a script as in the example below
    4. \n
  4. Configure Exported paths. The field lets you specify multiple directory patterns which will be added to the $PATH so that your build needn't know where the tool is actually installed
    5. \n
\n

\"Tool

\n
\n

Using tools in Freestyle projects

\n \n
\n

For Freestyle projects you need to add the tool requirement to your job's Build Environment (aka \"build wrappers\").

\n

\"Freestyle

\n

Then, you can just use the tool in your job, without having to know where it's installed. The plugin will install it as needed before your job runs, and make sure the $PATH is setup correctly:

\n

\"Freestyle

\n
\n

Advanced use-cases

\n \n
\n
\n

Tool versioning

\n \n
\n

Custom Tools plugin supports versioning of tools. Versions can be configured in the global configurations and then used to install specific versions of tools in Jenkins jobs.

\n \n
\n \n \n \n \n \n
WARNING: This feature is a subject to the breaking changes in the future. See JENKINS-32662 for more info
\n \n
\n

Configuring Tool versions

\n \n
\n

Currently the plugin uses the functionality provided by the Extended Choice Parameter plugin, but it's a subject for a change in the future. Extended Choice Parameter plugin allows to setup versions locally in the global configuration or to reference a property file with the version listing.

\n

If a Custom Tool has versioning enabled, Custom Tools starts retrieving versions during the tool installation. Version configuration example:

\n

\"Tool

\n

Some tool installers support TOOL_VERSION variables (e.g. all installers from Extra Tool Installers Plugin, so you can use versions in the installer configurations.

\n

\"Using

\n
\n

Tool Version parameters

\n \n
\n

Tool version parameter is available for Jenkins jobs. If it is not specified, a default version will be used.

\n

\"Tool

\n

Defining version parameter when starting a build:

\n

\"Tool

\n
\n
","rehypeTOC":[{"id":"plugin-content-overview","heading":"Overview"},{"id":"plugin-content-changelog","heading":"Changelog"},{"id":"plugin-content-usage","heading":"Usage","items":[{"id":"plugin-content-defining-tools","heading":"Defining tools"},{"id":"plugin-content-using-tools-in-freestyle-projects","heading":"Using tools in Freestyle projects"}]},{"id":"plugin-content-advanced-use-cases","heading":"Advanced use-cases","items":[{"id":"plugin-content-tool-versioning","heading":"Tool versioning","items":[{"id":"plugin-content-configuring-tool-versions","heading":"Configuring Tool versions"},{"id":"plugin-content-tool-version-parameters","heading":"Tool Version parameters"}]}]}]},"url":"https://github.com/jenkinsci/custom-tools-plugin"},"stats":{"currentInstalls":3080,"currentInstallPercentage":1.5041853468905364,"installations":[{"timestamp":1717200000000,"total":4085,"percentage":1.4470831621158233},{"timestamp":1719792000000,"total":4138,"percentage":1.446853146853147},{"timestamp":1722470400000,"total":4071,"percentage":1.4337132150957217},{"timestamp":1725148800000,"total":4027,"percentage":1.4536541696447265},{"timestamp":1727740800000,"total":4167,"percentage":1.4774238153486146},{"timestamp":1730419200000,"total":4065,"percentage":1.4519620239600524},{"timestamp":1733011200000,"total":3841,"percentage":1.442623689676283},{"timestamp":1735689600000,"total":3964,"percentage":1.4820076642676885},{"timestamp":1738368000000,"total":3988,"percentage":1.465982443500125},{"timestamp":1740787200000,"total":3985,"percentage":1.4179072613930717},{"timestamp":1743465600000,"total":3895,"percentage":1.3902372861997088},{"timestamp":1746057600000,"total":3080,"percentage":1.5041853468905364}],"trend":1139},"sha1":"hsxX0xHoH1PB/SUOHI3w8m43h2w=","deprecationNotice":null,"securityWarnings":[],"issueTrackers":[{"reportUrl":"https://www.jenkins.io/participate/report-issue/redirect/#16520/custom-tools-plugin","type":"jira","viewUrl":"https://issues.jenkins.io/issues/?jql=component=16520"}],"scm":"https://github.com/jenkinsci/custom-tools-plugin","hasPipelineSteps":false,"hasExtensions":false,"requiredCore":"2.222.4","releaseTimestamp":"2021-03-10T15:21:09.00Z","previousVersion":"0.7","previousTimestamp":"2019-08-16T21:11:10.00Z","name":"custom-tools-plugin","labels":["adopt-this-plugin","buildwrapper"],"developers":[{"id":"mPokornyETM","name":"mPokornyETM"},{"id":"oleg_nenashev","name":"Oleg Nenashev"},{"id":"rhernandezm","name":"Roberto"}],"firstRelease":"2012-02-13T19:54:52.000Z","excerpt":"A generic tool installer. You define how tools get installed, and the plugin will automatically install them when needed.","buildDate":"2021-03-10T00:00:00.000Z","dependencies":[{"implied":null,"name":"extended-choice-parameter","optional":false,"title":"Extended Choice Parameter","version":"0.28"},{"implied":null,"name":"matrix-project","optional":false,"title":"Matrix Project","version":"1.18"},{"implied":true,"name":"sshd","optional":false,"title":"SSH server","version":"3.236.ved5e1b_cb_50b_2"},{"implied":true,"name":"javax-activation-api","optional":false,"title":"JavaBeans Activation Framework (JAF) API","version":"1.2.0-2"},{"implied":true,"name":"javax-mail-api","optional":false,"title":"JavaMail API","version":"1.6.2-5"},{"implied":true,"name":"instance-identity","optional":false,"title":"Instance Identity","version":"3.1"}]}},"pageContext":{"name":"custom-tools-plugin"}},"staticQueryHashes":["443252636","734486537","810784101"],"slicesMap":{}}