diff --git a/DOCKER.md b/DOCKER.md index 302156f..ac7d88d 100644 --- a/DOCKER.md +++ b/DOCKER.md @@ -6,6 +6,8 @@ configured and ready to go. # Installation +To get started use docker and get the pipeline docker image. + ``` docker pull jemurai/pipeline:0.6 ``` @@ -13,15 +15,28 @@ docker pull jemurai/pipeline:0.6 # Usage ## Help + +This is one way to get help. +``` docker run jemurai/pipeline:0.6 --help +``` ## Typical Usage +Most basic starting point. Will analyze a predetermined codebase. +``` docker run jemurai/pipeline:0.6 +``` +Here is an example that runs on a github repo. +``` docker run jemurai/pipeline:0.6 https://github.com/YourOrg/YourProject.git +``` +This example only runs code analysis tools and outputs JSON. +``` docker run jemurai/pipeline:0.6 -l code -f json https://github.com/YourOrg/YourProject.git +``` Example: docker run jemurai/pipeline:0.6 -l code -f json https://github.com/Jemurai/triage.git @@ -44,16 +59,18 @@ a different directory you have to make it shared through VirtualBox or whatever # Dependencies -* Docker: https://get.docker.com/ -** Mac: https://docs.docker.com/mac/step_one/ -** Linux: https://docs.docker.com/linux/step_one/ -** Windows: https://docs.docker.com/windows/step_one/ +- Docker: https://get.docker.com/ + - Mac: https://docs.docker.com/mac/step_one/ + - Linux: https://docs.docker.com/linux/step_one/ + - Windows: https://docs.docker.com/windows/step_one/ # Development To run the code from the docker image, run the following: +``` docker run -i -t --entrypoint=/bin/bash jemurai/pipeline:0.6 +``` Then, you can run the tool as though you were developing it.