/atlassian-devbox

Atlassian Devbox to spin up any Atlassian enterprise product seamlessly

Primary LanguageJavaApache License 2.0Apache-2.0

atlassian-devbox

Quality Gate Status Security Rating Known Vulnerabilities npm version

requirements

install it

from homebrew

brew tap viqueen/atlassian-devbox
brew install atlassian-devbox

from npm

  • first time
npm install -g atlassian-devbox
  • does it need an update ?
npm outdated -g --depth=0
  • update it
npm update -g atlassian-devbox

from source

git clone git@github.com:viqueen/atlassian-devbox.git
cd atlassian-devbox

npm install
npm link

use it

It comes with the following enterprise product scripts that behave exactly the same

# running and debugging atlassian server instances
confluence -h
jira -h
bitbucket -h
bamboo -h
crowd -h
fecru -h
ctk-server -h

For example this is what the Confluence script documentation looks like

Usage: confluence [options] [command]

Options:
  -hp, --http-port <httpPort>        with http port (default: "1990")
  -dp, --debug-port <debugPort>      with debug port (default: "5005")
  -cp, --context-path <contextPath>  with context path (default: "/confluence")
  -ap, --ajp-port <ajpPort>          with ajp port (default: "8009")
  --plugins <plugins>                with plugins
  --jvm-args <jvmArgs>               with jvmargs
  --amps-version <ampsVersion>       with amps version (default: "8.2.0")
  -V, --version                      output the version number
  -h, --help                         display help for command

Commands:
  start <version>                    runs confluence
  debug <version>                    runs confluence with debug port open
  cmd <name> <version>               prints the resolved command
  list                               lists installed confluence instances
  remove <pattern>                   removes confluence instance with version matching given pattern
  logs <version>                     tails confluence logs
  versions                           lists available confluence versions in local maven repo
  purge <type>                       purges available confluence versions in local maven repo
  help [command]                     display help for command
  • start a confluence instance
confluence start 7.4.9
  • tail the logs
confluence logs 7.4.9
  • debug a confluence instance
confluence debug 7.4.9
  • print the underlying command
confluence cmd start 7.4.9
confluence cmd debug 7.4.9
  • list installed versions
confluence list
  • remove some installed version
confluence remove 7.4.9
confluence remove 7.4 # removes all 7.4.x instances
  • list available versions in local cache
confluence versions
  • purge versions in local cache
confluence purge internal # remove any snapshots / milestones / beta / release candidates
confluence purge all      # purges the whole thing