Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


JENKINS_URL can be specified via the environment variable $JENKINS_URL. This environment variable is automatically set when Jenkins fork a process during builds, which allows you to use Jenkins CLI from inside the build without explicitly configuring the URL.

For details on authentication methods ("-auth" parameter or JENKINS_USER_ID and JENKINS_API_TOKEN environment variables), see Jenkins CLI > Client connection modes > HTTP connection mode.

Getting help

The list of the available commands depends on the server you are talking to. Visit or use 'help' command to list them all:


  1. Jenkins listens on a TCP/IP port configured under "TCP port for JNLP agents" in the system configuration page. This single port is used for both agents and CLI.
  2. Jenkins advertises this port number as a special HTTP header (if disabled, this header will not be present).)
  3. CLI client will make an HTTP request to the top page of Jenkins, looking for this header.
  4. If the header is found and the TCP/IP port is identified, the client will attempt to connect to this URL.
  5. If that fails (for example, if there's a reverse proxy and Jenkins runs on a different host, or if a firewall blocks access to this TCP/IP port), or if the header is not found, it will fall back to the communication mechanism that uses two simultaenous HTTP connections.