@@ -8,7 +8,7 @@ This guide mainly used the tool on Java projects, it is perfectly possible to ru
88
99For this guide, there are two ways to install the tool:
1010
11- !!! cube "Normal installation"
11+ !!! cube "Local installation"
1212 - You will need to install the following packages:
1313
1414 - `git`
@@ -23,13 +23,8 @@ For this guide, there are two ways to install the tool:
2323 - [SpotBugs](/sast/supported/spotbugs.j2.html){:target="_blank"}
2424
2525!!! docker "Docker image"
26- A Docker image used to run tests is available with the prerequisites installed.
27- You can use it to test CodeSecTools without installing extra packages on your system.
28-
29- ⚠️ However, this container is intended for running tests, not for normal usage.
30- Therefore, any data and results inside the container will be deleted when you exit.
31-
32- Please perform a normal installation if you want to keep your results.
26+ A Docker image is available with the prerequisites installed.
27+ You can use it to run CodeSecTools without installing extra packages on your system.
3328
3429
3530## 2. Installation
@@ -60,17 +55,26 @@ For this guide, there are two ways to install the tool:
6055 ```
6156
6257!!! docker "Docker image"
63- To start the Docker container, run the command:
58+ Create a new directory which will be mounted in the docker container and start the container:
59+ ```bash
60+ mkdir codesectools_quick_start_guide
61+ cd codesectools_quick_start_guide
62+ cstools docker
63+ ```
64+
65+ Then inside the container:
6466 ```bash
65- make test-debug
67+ cd codesectools_quick_start_guide
6668 ```
6769
68- ⚠️ The container will be deleted when you exit .
70+ Only data inside `./codesectools_quick_start_guide` are saved .
6971
7072
7173## 3. First run
7274
7375!!! abstract "Install completion (optional)"
76+ * Completion is already installed in the Docker container.*
77+
7478 ```bash
7579 cstools --install-completion
7680 # For bash
0 commit comments