Skip to content

Commit 6977201

Browse files
committed
extend source code docs
1 parent b877244 commit 6977201

File tree

1 file changed

+23
-8
lines changed

1 file changed

+23
-8
lines changed

pages/tidal tools/sourcecode.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,13 @@ When analyzing a source code (or multiple), you have two options.
4949

5050
```bash
5151
cd /path/to/source-code
52-
tidal analyze code --app-id 111
52+
tidal analyze code --app-id [app_id_for_your_application]
5353
```
5454

5555
Alternatively, you can pass the location to the source code.
5656

5757
```bash
58-
tidal analyze code ~/location/to-source-code/ --app-id 111
58+
tidal analyze code [/path/to/source-code] --app-id [app_id_for_your_application]
5959
```
6060

6161
2. Perform the source code analysis and upload the results **at a later time**. The following section will explain how to run database analysis in **offline mode**
@@ -78,28 +78,43 @@ These are the steps you need to follow in order to bypass internet access limita
7878

7979
`tidal restore tidal-snapshot_DATE.tar`
8080

81-
This will load a docker image and all the existing Tidal Tools configurations from the original machine. You can now run the source code analysis without any external network connectivity.
81+
This will load a docker image and all the existing Tidal Tools configurations from the original machine.
8282

83-
`tidal analyze code [path/to-directory] --offline --output-dir [directory]`
83+
4. You can now run the source code analysis without any external network connectivity.
84+
85+
```bash
86+
cd /path/to/source-code
87+
tidal analyze code --offline --output-dir [directory]
88+
```
89+
90+
Alternatively, you can pass the location to the source code.
91+
92+
```bash
93+
tidal analyze code [/path/to/source-code] --offline --output-dir [directory]
94+
```
8495

8596
Note:
8697

8798
- The `--offline` flag indicates to Tidal Tools that the output needs to be stored in a file instead of being uploaded.
8899
- The `--output-dir` flag determines where the output will be located.
89100

90-
After the analysis is completed, you will find a zip file called, `result-<DATE>.zip` that can then be transferred into a machine with internet connectivity.
101+
After the analysis is completed, you will find an artifact file called `code-analysis-<DATE>-<TYPE>.json` that can then be transferred into a machine with internet connectivity.
91102

92-
4. Back to the machine with internet access, you can now upload your results to your workspace with this command.
103+
5. Back to the machine with internet access, you can now upload your results to your workspace with this command.
93104

94-
`tidal analyze code --app-id [app_id_for_your_application] --upload [file_name]`
105+
106+
```bash
107+
tidal analyze code upload [file_name] --app-id [app_id_for_your_application]`
108+
```
95109

96110
You should receive confirmation that the upload has been completed and can navigate to Tidal to see the results.
97111

98112
{% include tip.html content="Need to run code analysis on a entire set of applications all from one machine? Run [this command and easily create a directory for every application already in Tidal Migrations](https://github.com/tidalmigrations/gists/blob/master/make_source_code_dirs.sh)" %}
99113

100114
### Why Docker?
101115

102-
You need to install Docker in order to complete the source code analysis. This is because the analysis uses several system dependent software libraries so by using Docker the analysis can use those libraries without you requiring to install the correct versions and dependencies.
116+
You need to install Docker in order to complete the source code analysis. This is because the analysis uses several system dependent software libraries.
117+
By using Docker, the analysis can use those libraries without requiring you to install any other dependencies.
103118

104119
### What about security?
105120

0 commit comments

Comments
 (0)