Skip to content

Commit

Permalink
Add a output results section in tutorial 1 #8
Browse files Browse the repository at this point in the history
Signed-off-by: Thomas Druez <tdruez@nexb.com>
  • Loading branch information
tdruez committed Sep 18, 2020
1 parent 2923659 commit 0f6d25a
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions docs/scanpipe-tutorial-1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,17 +44,12 @@ You can also copy more files manually to this `input/` directory including entir

- Check that the docker pipeline as added to your project::

scanpipe show-pipeline --project p1
$ scanpipe show-pipeline --project p1

Notes: Using this `scanpipe show-pipeline` command lists all the pipelines added and their planned runs.
You can use this to get a quick overview of the pipelines that have been running already
(with their success "V" or fail status "f") and those that will be running next when you invoke the run command.

For example::

$ scanpipe show-pipeline --project p1
> "[ ] scanpipe/pipelines/docker.py"

- Run the docker pipeline proper on this project::

$ scanpipe run --project p1
Expand All @@ -64,14 +59,17 @@ Executing the show-pipeline command again will confirm the success of the pipeli
$ scanpipe show-pipeline --project p1
> "[V] scanpipe/pipelines/docker.py"

- Get the results of the pipeline run as a JSON file using the output command::

$ scanpipe output --project p1 results.json

As a shortcut, the inputs and pipelines can be provided directly at once when
calling the `create-project` command. For example, this command will create a
project named `p2` copy our test docker image to the project's inputs and add
the docker pipeline in one operation::

$ scanpipe create-project p2 --input ~/30-alpine-nickolashkraus-staticbox-latest.tar --pipeline scanpipe/pipelines/docker.py


Next step
---------

Expand Down

0 comments on commit 0f6d25a

Please sign in to comment.