Skip to content

Commit

Permalink
docs: Show how to route output to current directory
Browse files Browse the repository at this point in the history
By default the output is written inside the container.

Signed-off-by: rrrutledge <rrrutledge@users.noreply.github.com>
  • Loading branch information
rrrutledge authored and sschuberth committed Jun 22, 2023
1 parent 5bb199c commit 4d240a9
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/hints-for-use-with-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ docker run \
-v $PWD/:/project \ # Mount current working directory into /project to use as input.
ort --info \
-c /project/ort/config.yml \ # Use file from "<workingdirectory>/ort" as config.
analyze -i /project [...] # Insert further arguments for the command.
analyze -i /project \ # Analyze the current working directory using the alias (set earlier in the -v option).
-o /project \ # Output goes into the current working directory.
[...] # Insert further arguments for the command.
```

If only a subproject shall be analyzed, change the input path `-i /project` to `-i /project/subproject`. Note that still the projects root directory needs to be mounted to Docker for ORT to detect VCS information.
Expand Down

0 comments on commit 4d240a9

Please sign in to comment.