jenkins-project-cli

jenkins-project-cli - jenkins command line interface

Installation

# Install it from npm 
npm install -g jenkins-project-cli

Usage

jenkins-project-cli exposes a command line interface

jenkins-project-cli usage:
 -    pull - pull jenkins configuration for [project]
 -    push - push jenkins configuration for [project]
 -    build - trigger build for [project]
 -    watch - watch current build for [project]
 -    list - list available projects
 -    help - print this help

Configuration

jenkins-project-cli can be configured via package.json in config.jenkins, via .jenkinsrc and .env files. All configuration keys can be overridden via cli, by specifying --${key}=${value}.

.jenkins-project-clirc

{
  "host": "https://jenkins-host.tld",   // jenkins instance to use
  "group": "jenkins-group",             // jenkins group to use
  "directory": "configuration/jenkins", // directory to save project config.xmls to
  "default": "jenkins-project-cli",             // project name to default to
  "projects": [                         // project names to execute subcommands for
    "jenkins-project-cli",
    "jenkins-project-cli-publish",
    "jenkins-project-cli-test"
  ]
}

.env

# Use .env to save credentials for later use
# It is recommended to place this in .gitignore
JENKINS_PROJECT_CLI_USERNAME=[YOUR-USERNAME]
JENKINS_PROJECT_CLI_PASSWORD=[YOUR-PASSWORD]

package.json

{
  "name": "jenkins-project-cli",
  "config": {
    "jenkins-project-cli": {
        "host": "https://jenkins-host.tld",
        "group": "jenkins-group",
        "directory": "configuration/jenkins",
        "default": "jenkins-project-cli",
        "projects": [
          "jenkins-project-cli",
          "jenkins-project-cli-publish",
          "jenkins-project-cli-test"
        ]
      }
    }
  }
}

---

Copyright 2016 by Mario Nebl and contributors. Released under the MIT license. The jenkins logo is released under the Creative Commons Attribution-ShareAlike 3.0 Unported License and created by the jenkins project