Skip to content

Commit

Permalink
update saf docker install readme instructions (#542)
Browse files Browse the repository at this point in the history
* update saf docker install readme instructions

Signed-off-by: Emily Rodriguez <ecrodriguez@mm279976-pc.lan>

* updated to show both options

Signed-off-by: Emily Rodriguez <ecrodriguez@mm279976-pc.lan>

Signed-off-by: Emily Rodriguez <ecrodriguez@mm279976-pc.lan>
Co-authored-by: Emily Rodriguez <ecrodriguez@mm279976-pc.lan>
  • Loading branch information
em-c-rod and Emily Rodriguez authored Sep 12, 2022
1 parent 01af094 commit 872adeb
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,16 +100,30 @@ brew upgrade mitre/saf/saf-cli

**On Linux and Mac:**

The docker command below can be used to run the SAF CLI one time, where `arguments` contains the command and flags you want to run. For ex: `--version` or `view summary -i hdf-results.json`.
```
docker run -it -v$(pwd):/share mitre/saf
docker run -it -v$(pwd):/share mitre/saf <arguments>
```

To run the SAF CLI with a persistent shell for one or more commands, use the following, then run each full command. For ex: `saf --version` or `saf view summary -i hdf-results.json`. You can change the entrypoint you wish to use. For example, run with `--entrypoint sh` to open in a shell terminal. If the specified entrypoint is not found, try using the path such as `--entrypoint /bin/bash`.

```
docker run --rm -it --entrypoint bash -v$(pwd):/share mitre/saf
```

**On Windows:**

The docker command below can be used to run the SAF CLI one time, where `arguments` contains the command and flags you want to run. For ex: `--version` or `view summary -i hdf-results.json`.

```
docker run -it -v%cd%:/share mitre/saf
docker run -it -v%cd%:/share mitre/saf <arguments>
```

To run the SAF CLI with a persistent shell for one or more commands, use the following, then run each full command. For ex: `saf --version` or `saf view summary -i hdf-results.json`. You can change the entrypoint you wish to use. For example, run with `--entrypoint sh` to open in a shell terminal. If the specified entrypoint is not found, try using the path such as `--entrypoint /bin/bash`.

```
docker run --rm -it --entrypoint sh -v%cd%:/share mitre/saf
```


#### Update via Docker
Expand Down

0 comments on commit 872adeb

Please sign in to comment.