Skip to content

Commit

Permalink
Jighlighting and examples.
Browse files Browse the repository at this point in the history
  • Loading branch information
mkonda committed Dec 29, 2015
1 parent 265f1db commit 8644fd0
Showing 1 changed file with 21 additions and 4 deletions.
25 changes: 21 additions & 4 deletions DOCKER.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,37 @@ configured and ready to go.

# Installation

To get started use docker and get the pipeline docker image.

```
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
Expand All @@ -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.

Expand Down

0 comments on commit 8644fd0

Please sign in to comment.