@appland/appmap 3.168.0 → 3.168.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/built/docs/appmap-docs.md +1 -1
  3. package/built/docs/community.md +1 -1
  4. package/built/docs/get-started-with-appmap/index.md +1 -1
  5. package/built/docs/get-started-with-appmap/navie-ai-quickstart.md +6 -5
  6. package/built/docs/navie-reference/index.md +18 -0
  7. package/built/docs/navie-reference/navie-accessing-logs.md +42 -0
  8. package/built/docs/navie-reference/navie-bring-your-own-model-examples.md +202 -0
  9. package/built/docs/navie-reference/navie-commands.md +119 -0
  10. package/built/docs/navie-reference/navie-github-repository.md +12 -0
  11. package/built/docs/{using-navie-ai/how-navie-works.md → navie-reference/navie-how-it-works.md} +5 -4
  12. package/built/docs/navie-reference/navie-openai-key-management.md +83 -0
  13. package/built/docs/navie-reference/navie-options.md +87 -0
  14. package/built/docs/navie-reference/navie-pre-built-libraries-for-appmap-data.md +23 -0
  15. package/built/docs/navie-reference/navie-user-interface.md +32 -0
  16. package/built/docs/navie-reference.md +1 -0
  17. package/built/docs/reference/appmap-airgapped-install.md +293 -0
  18. package/built/docs/reference/appmap-client-cli.md +1 -1
  19. package/built/docs/reference/appmap-java.md +1 -1
  20. package/built/docs/reference/guides/exporting-appmap-diagrams.md +1 -0
  21. package/built/docs/reference/guides/handling-large-appmap-diagrams.md +1 -1
  22. package/built/docs/reference/guides/index.md +1 -0
  23. package/built/docs/reference/guides/navigating-code-objects.md +2 -2
  24. package/built/docs/reference/guides/openapi.md +1 -1
  25. package/built/docs/reference/guides/reading-sql-in-appmap-diagrams.md +1 -1
  26. package/built/docs/reference/guides/refine-appmap-data.md +1 -1
  27. package/built/docs/reference/guides/reverse-engineering.md +1 -0
  28. package/built/docs/reference/guides/using-appmap-analysis.md +1 -1
  29. package/built/docs/reference/guides/using-appmap-diagrams.md +2 -2
  30. package/built/docs/reference/index.md +3 -1
  31. package/built/docs/reference/integrations/atlassian-compass.md +1 -0
  32. package/built/docs/reference/integrations/atlassian-confluence.md +1 -0
  33. package/built/docs/reference/integrations/docker.md +1 -0
  34. package/built/docs/reference/integrations/index.md +1 -0
  35. package/built/docs/reference/integrations/mermaid.md +1 -0
  36. package/built/docs/reference/integrations/plantuml.md +1 -0
  37. package/built/docs/reference/integrations/postman.md +1 -0
  38. package/built/docs/reference/integrations/readme.md +1 -0
  39. package/built/docs/reference/integrations/smartbear-swaggerhub.md +2 -1
  40. package/built/docs/reference/uninstalling-appmap.md +1 -1
  41. package/built/docs/reference/vscode.md +1 -1
  42. package/built/docs/using-navie-ai/bring-your-own-model.md +38 -37
  43. package/built/docs/using-navie-ai/how-to-open-navie.md +5 -5
  44. package/built/docs/using-navie-ai/index.md +8 -7
  45. package/built/docs/using-navie-ai/using-navie.md +64 -75
  46. package/built/fulltext/FileIndex.js +0 -1
  47. package/built/fulltext/FileIndex.js.map +1 -1
  48. package/package.json +1 -1
  49. package/built/docs/reference/integrations/circle-ci.md +0 -425
@@ -0,0 +1,87 @@
1
+ ---
2
+ layout: docs
3
+ title: Docs - AppMap Navie
4
+ description: "Reference Guide to AppMap Navie AI, a complete list of options available in AppMap Navie AI."
5
+ name: Navie Options
6
+ navie-reference: true
7
+ step: 4
8
+ toc: true
9
+ ---
10
+
11
+ # Navie Options
12
+
13
+ Navie supports forward-slash options that can be included at the beginning of your questions to control various aspects of text generation.
14
+
15
+ ## /tokenlimit
16
+
17
+ The `/tokenlimit` option is used to specify a limit on the number of tokens processed by the system. This parameter can help control the length of the generated text or manage resource consumption effectively.
18
+
19
+ **Syntax**
20
+ ```shell
21
+ /tokenlimit=<value>
22
+ ```
23
+ - `<value>`: The maximum number of tokens to be processed. This can be either a string or a number. If provided as a string, it will be automatically converted to an integer.
24
+
25
+ **Description**
26
+ When executing commands, the `/tokenlimit` option sets the upper limit on the number of tokens the system should utilize. The default token limit is 8000. Increasing the token limit allows more space for context.
27
+
28
+ **Example**
29
+ To set the token limit to 16000, you can use:
30
+ ```shell
31
+ @explain /tokenlimit=16000 <question>
32
+ ```
33
+
34
+ **Notes**
35
+ - It's important to ensure that the value provided for `/tokenlimit` is a valid positive integer.
36
+ - The effect of `/tokenlimit` can directly impact the performance and output length of text generation processes.
37
+ - The `/tokenlimit` cannot be increased above the fundamental limit of the LLM backend. Some backends, such as Copilot, may have a lower token limit than others.
38
+
39
+
40
+ ## /temperature
41
+
42
+ The `/temperature` option is used to control the randomness of the text generation process. This parameter can help adjust the creativity and diversity of the generated text.
43
+
44
+ **Syntax**
45
+ ```shell
46
+ /temperature=<value>
47
+ ```
48
+
49
+ - `<value>`: The temperature value to be set. This can be either a string or a number. If provided as a string, it will be automatically converted to a float.
50
+
51
+ **Description**
52
+ When executing commands, the `/temperature` option sets the randomness of the text generation process. The default temperature value is 0.2. Lower values result in more deterministic outputs, while higher values lead to more creative and diverse outputs.
53
+
54
+ **Example**
55
+ To set the temperature to 0, you can use:
56
+ ```shell
57
+ @generate /temperature=0 <question>
58
+ ```
59
+
60
+ **Notes**
61
+
62
+ - It's important to ensure that the value provided for `/temperature` is a valid float.
63
+ - The effect of `/temperature` can directly impact the creativity and diversity of the generated text.
64
+
65
+ ## /include and /exclude
66
+
67
+ The `/include` and `/exclude` options are used to include or exclude specific file patterns from the retrieved context.
68
+
69
+ **Syntax**
70
+ ```shell
71
+ /include=<word-or-pattern>|<word-or-pattern> /exclude=<word-or-pattern>|<word-or-pattern>
72
+ ```
73
+
74
+ - `<word-or-pattern>`: The word or pattern to be included or excluded. Multiple values or patterns can be separated by a pipe `|`, because the entire string is treated as a
75
+ regular expression.
76
+
77
+ **Description**
78
+
79
+ When executing commands, the `/include` option includes files according to the words or patterns specified, while the `/exclude` option excludes them. This can help control the context used by the system to generate text.
80
+
81
+ **Example**
82
+
83
+ To include only Python files and exclude files containing the word "test":
84
+
85
+ ```shell
86
+ @plan /include=\.py /exclude=test
87
+ ```
@@ -0,0 +1,23 @@
1
+ ---
2
+ layout: docs
3
+ title: Docs - AppMap Navie
4
+ description: "Reference Guide to AppMap Navie AI, pre-built libraries for recording AppMap data."
5
+ name: Pre-built Libraries for Recording AppMap Data
6
+ navie-reference: true
7
+ step: 12
8
+ ---
9
+
10
+ # Pre-built Libraries for Recording AppMap Data
11
+
12
+ AppMap Navie AI supports all software languages and frameworks for coding with static analysis and static diagrams based on the software.
13
+
14
+ For advanced runtime analysis of deep tracing of APIs, packages, classes, functions, databases, etc. behavioral analysis, make AppMap data for your project available to Navie.
15
+
16
+ AppMap offers pre-built libraries for creating AppMap data:
17
+
18
+ - [Java](https://github.com/getappmap/appmap-java)
19
+ - [Ruby](https://github.com/getappmap/appmap-ruby)
20
+ - [Python](https://github.com/getappmap/appmap-python)
21
+ - [Node.js](https://github.com/getappmap/appmap-agent-js)
22
+
23
+ To learn how to make AppMap data of these languages, refer to [making AppMap Data documentation](/docs/get-started-with-appmap/making-appmap-data)
@@ -0,0 +1,32 @@
1
+ ---
2
+ layout: docs
3
+ title: Docs - Reference
4
+ name: Navie User Interface
5
+ step: 11
6
+ navie-reference: true
7
+ description: "Reference Guide to AppMap Navie AI, describing the user interface."
8
+ ---
9
+
10
+ ## User Interface
11
+ AppMap Navie AI is an AI assistant that enables you to ask architectural level questions about your code base. Navie is also able to help you generate new code that can span across your entire project. The primary user interface for Navie is within your VS Code or JetBrains code editor. Refer to the Navie docs to [learn how to open Navie](/docs/using-navie-ai/how-to-open-navie) for your code editor.
12
+
13
+ ![Navie User Interface](/assets/img/docs/appmap-navie-user-interface.webp)
14
+
15
+ ### Basic Layout
16
+
17
+ The Navie user interface consists of 5 key areas.
18
+
19
+ <ol type="A">
20
+ <b><li>AppMap Data Status Panel</li></b>
21
+ This panel will list the current status of the AppMap Data that has been created for your project. AppMap Data are your application runtime traces which include things like HTTP and SQL requests, data flows, class and function level instrumentation, and more. Without AppMap Data created for your project, Navie can search through your static source code in your workspace for relevant code snippets.
22
+ <b><li>Navie Context Window</li></b>
23
+ Upon asking a question to Navie it will search through your AppMap Data (if exists) and the source code in your open workspace to locate all the relevant context for your question. This area will reflect the information that Navie is aware of when answering. You can use this information to better understand how Navie is responding.
24
+ <b><li>LLM Model Config Button</li></b>
25
+ You can configure Navie to use your own OpenAI API key or bring your own LLM model running locally or within another provider. Clicking the gear icon will open the configuration modal for the bring your own model settings. <a href="/docs/using-navie-ai/bring-your-own-model">Refer to the AppMap docs for more details</a>
26
+ about how to configure Navie to use your own LLM models.
27
+ <b><li>Active LLM Model</li></b>
28
+ This panel will display the currently configured LLM model in use with Navie. The LLM details are displayed in the following format: <code>Model: &lt;Model Name&gt; (&lt;location&gt;)</code>. When using the default Navie backend, the location will be listed as <code>default</code>. When using your own OpenAI API key the location will be listed as <code>via OpenAI</code>. When using <a href="/docs/using-navie-ai/bring-your-own-model.html#configuration">Navie Bring Your Own Model</a>
29
+ , the location will be the value of the <code>OPENAI_BASE_URL</code> environment variable, for example <code>via localhost</code> when using <a href="/docs/using-navie-ai/bring-your-own-model.html#ollama">Ollama</a> or <a href="/docs/using-navie-ai/bring-your-own-model.html#lm-studio">LM Studio</a>.
30
+ <b><li>Navie Chat Window</li></b>
31
+ This is your primary location for interacting with Navie. Here you can ask Navie questions about how your application works, ask Navie to generate code or test cases, and you can even have Navie create a pull request based on your changes. To learn more about specific Navie commands refer to the <a href="#navie-commands">Navie Commands</a> section.
32
+ </ol>
@@ -3,6 +3,7 @@ layout: docs
3
3
  title: Docs - Reference
4
4
  toc: true
5
5
  description: "Reference Guide to AppMap Navie, including advanced usage and configuration"
6
+ redirect_for: [/docs/reference/navie]
6
7
  ---
7
8
 
8
9
  # Navie Reference
@@ -0,0 +1,293 @@
1
+ ---
2
+ layout: docs
3
+ title: Docs - Reference
4
+ description: "Learn how to install AppMap components like IDE plugins, libraries in a secure or air-gapped network environment."
5
+ toc: true
6
+ reference: true
7
+ name: AppMap Offline Install for Secure Environments
8
+ step: 19
9
+ ---
10
+
11
+ # AppMap Offline Install for Secure Environments
12
+
13
+ - [Assumptions](#assumptions)
14
+ - [Download Steps](#download-steps)
15
+ - [Download the AppMap VS Code Plugin (VSIX)](#download-the-appmap-vs-code-plugin-vsix)
16
+ - [Download the AppMap JetBrains Plugin (zip)](#download-the-appmap-jetbrains-plugin-zip)
17
+ - [Download the AppMap Application Binaries](#download-the-appmap-application-binaries)
18
+ - [Download the AppMap Java Jar file](#download-the-appmap-java-jar-file)
19
+ - [Installation Steps](#installation-steps)
20
+ - [Install the AppMap VS Code Plugin (VSIX)](#install-the-appmap-vs-code-plugin-vsix)
21
+ - [Install the AppMap Plugin for JetBrains (zip)](#install-the-appmap-plugin-for-jetbrains-zip)
22
+ - [Install the AppMap Application Binaries for VS Code](#install-the-appmap-application-binaries-for-vs-code)
23
+ - [Install the AppMap Application Binaries for JetBrains](#install-the-appmap-application-binaries-for-jetbrains)
24
+ - [Install the AppMap Java Jar file](#install-the-appmap-java-jar-file)
25
+ - [Confirm Successful Installation](#confirm-successful-installation)
26
+
27
+ ## Assumptions
28
+
29
+ Access to the following domains for downloading the AppMap application assets manually.
30
+
31
+ * [https://github.com/](https://github.com/)
32
+ * For downloading the VS Code or JetBrains extension files
33
+ * For downloading the AppMap application binaries
34
+ * [https://getappmap.com](https://getappmap.com)
35
+ * To authenticate your VS Code installation
36
+ * NOTE: This is only necessary if you don’t have AppMap provided license keys.
37
+
38
+ ## Download Steps
39
+
40
+ ### Download the AppMap VS Code Plugin (VSIX)
41
+
42
+ **If you are a JetBrains User, go to the [download documentation for the JetBrains plugin](#download-the-appmap-jetbrains-plugin-zip).**
43
+
44
+ Navigate to the the AppMap [VS Code GitHub latest releases page](https://github.com/getappmap/vscode-appland/releases/latest):
45
+
46
+ This URL will take you to the most recently released version of the extension.
47
+
48
+ Alternatively, you can navigate to [the main releases page](https://github.com/getappmap/vscode-appland/releases/) to install any specific version of the extension.
49
+
50
+ Click on the VSIX file to save the file to your local machine.
51
+
52
+ <img class="video-screenshot" src="/assets/img/docs/offline-install-1.webp"/>
53
+
54
+ ### Download the AppMap JetBrains Plugin (zip)
55
+
56
+ Alternatively if you are a JetBrains user, navigate to the AppMap GitHub repository for the [JetBrains/IntelliJ plugin latest releases page](https://github.com/getappmap/appmap-intellij-plugin/releases/latest).
57
+
58
+ Download the zip file and save locally.
59
+
60
+ <img class="video-screenshot" src="/assets/img/docs/offline-install-1b.webp"/>
61
+
62
+ ### Download the AppMap Application Binaries
63
+
64
+ Navigate to the [AppMap application binaries release page](https://github.com/getappmap/appmap-js/releases).
65
+
66
+ Search within the page for a release with the name “@appland/appmap”.
67
+
68
+ <img class="video-screenshot" src="/assets/img/docs/offline-install-2.webp"/>
69
+
70
+ <div class="alert alert-info">NOTE: You may need to navigate to page 2 depending on the number of released AppMap binaries.</div>
71
+
72
+ Click on the “Assets” button to expand all the available AppMap binaries.
73
+
74
+ <img class="video-screenshot" src="/assets/img/docs/offline-install-3.webp"/>
75
+
76
+ Download the binary that is specific to your computers’ operating system and architecture. Optionally download the sha256 file as well if you wish to validate the files’ integrity on your local machine.
77
+
78
+ ### Download the AppMap Java Jar file
79
+
80
+ <div class="alert alert-info">NOTE: The VSIX will be bundled with the latest java jar file from the same release, but this is not guaranteed to be the same as the most recently released version. The steps below will ensure you can download the latest release if your machine is unable to manually update.</div>
81
+
82
+ To record Java applications, you’ll need to download the AppMap Java Jar file for the code editor extension to use.
83
+ Navigate to the [AppMap Java releases page](https://github.com/getappmap/appmap-java/releases/latest) for the latest releases of this project.
84
+
85
+
86
+ In the Assets section, download the `appmap-<version>.jar` file and optionally the .asc file if you would like to validate the file integrity on your local machine.
87
+
88
+ <img class="video-screenshot" src="/assets/img/docs/offline-install-4.webp"/>
89
+
90
+ ## Installation Steps
91
+
92
+ ### Install the AppMap VS Code Plugin (VSIX)
93
+
94
+ Open VS Code, and then open the Command Palette:
95
+ Mac: `Command + Shift + P`
96
+ Windows: `Control + Shift + P`
97
+
98
+ After opening the Command Palette, search for “install from VSIX”
99
+
100
+ <img class="video-screenshot" src="/assets/img/docs/offline-install-5.webp"/>
101
+
102
+ In the following window, locate the VSIX you downloaded previously and select that for installation.
103
+
104
+ <img class="video-screenshot" src="/assets/img/docs/offline-install-6.webp"/>
105
+
106
+ <html lang="en">
107
+ <head>
108
+ <meta charset="UTF-8">
109
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
110
+ <title>Shift Bullet Points</title>
111
+ <style>
112
+ .shifted-list {
113
+ padding-left: 40px;
114
+ }
115
+ </style>
116
+ </head>
117
+ <body>
118
+ <div class="alert alert-info">
119
+ NOTE: If VS Code is able to connect to the following domains, AppMap binary asset download will complete successfully.
120
+ <ul class="shifted-list">
121
+ <li>objects.githubusercontent.com</li>
122
+ <li>*.github.com</li>
123
+ </ul>
124
+ If access to those URLs is blocked, continue to the “Install Application Binaries” steps below.
125
+ </div>
126
+ </body>
127
+ </html>
128
+
129
+ ### Install the AppMap Plugin for JetBrains (zip)
130
+
131
+ Open your JetBrains editor, and open the “Settings” page.
132
+
133
+ <img class="video-screenshot" src="/assets/img/docs/offline-install-7.webp"/>
134
+
135
+ The settings page should look similar to below.
136
+
137
+ <img class="video-screenshot" src="/assets/img/docs/offline-install-8.webp"/>
138
+
139
+ Search for, or select the “Plugins” option, then select the gear icon and choose “Install Plugin from Disk”
140
+
141
+ <img class="video-screenshot" src="/assets/img/docs/offline-install-9.webp"/>
142
+
143
+ Select the path to the zip file you [downloaded in the previous section](#download-the-appmap-jetbrains-plugin-zip).
144
+
145
+ After selecting the AppMap zip file, click “Accept” for the “Third-Party Plugins Notice”
146
+
147
+ <img class="video-screenshot" src="/assets/img/docs/offline-install-10.webp"/>
148
+
149
+ <div class="alert alert-info">Note: After clicking “Accept” to the JetBrains plugin notice you may need to go back to the previous “Install Plugin from Disk” step and repeat to install the plugin.</div>
150
+
151
+ When the plugin is successfully installed, you will see it in the settings page plugin list.
152
+
153
+ <img class="video-screenshot" src="/assets/img/docs/offline-install-11.webp"/>
154
+
155
+ If you don’t see it in the list, search for AppMap in the search box to confirm the installation is complete.
156
+
157
+ <img class="video-screenshot" src="/assets/img/docs/offline-install-12.webp"/>
158
+
159
+ After closing the settings page, the AppMap plugin will open.
160
+
161
+ AppMap collects anonymous usage stats to improve the product, in the pop up on the bottom of the screen, choose to “Opt out” or simply close the popup to keep these anonymous product analytics enabled.
162
+
163
+ <img class="video-screenshot" src="/assets/img/docs/offline-install-13.webp"/>
164
+
165
+ <html lang="en">
166
+ <head>
167
+ <meta charset="UTF-8">
168
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
169
+ <title>Shift Bullet Points</title>
170
+ <style>
171
+ .shifted-list {
172
+ padding-left: 40px; /* Adjust this value to shift more or less */
173
+ }
174
+ </style>
175
+ </head>
176
+ <body>
177
+ <div class="alert alert-info">
178
+ NOTE: If VS Code is able to connect to the following domains, AppMap binary asset download will complete successfully.
179
+ <ul class="shifted-list">
180
+ <li>objects.githubusercontent.com</li>
181
+ <li>*.github.com</li>
182
+ <li>registry.npmjs.org</li>
183
+ </ul>
184
+ If access to those URLs is blocked, continue to the “Install Application Binaries” steps below.
185
+ </div>
186
+ </body>
187
+ </html>
188
+
189
+ ### Install the AppMap Application Binaries for VS Code
190
+
191
+ Copy the binary you downloaded in the [previous step](#download-the-appmap-application-binaries) to the following location.
192
+
193
+ #### On Mac and Linux <!-- omit in toc -->
194
+
195
+ <pre><code>$HOME/.appmap/bin/appmap</code></pre>
196
+
197
+ The file needs to be made executable. You can run the following command.
198
+ <pre><code>chmod +x $HOME/.appmap/bin/appmap</code></pre>
199
+
200
+ #### On Windows <!-- omit in toc -->
201
+
202
+ <pre><code>%USERPROFILE%\.appmap\bin\appmap.exe</code></pre>
203
+
204
+ ### Install the AppMap Application Binaries for JetBrains
205
+
206
+ Copy the binary you downloaded in the [previous step](#download-the-appmap-application-binaries) and to the following location.
207
+
208
+ #### On Mac <!-- omit in toc -->
209
+
210
+ <pre><code>$HOME/Library/Caches/JetBrains/appland-plugin/appmap/&lt;version&gt;/appmap-macos-arm64</code></pre>
211
+
212
+ Create the subdirectories if they don’t already exist.
213
+
214
+ For example:
215
+
216
+ <pre><code>$HOME/Library/Caches/JetBrains/appland-plugin/appmap/3.164.0/appmap-macos-arm64</code></pre>
217
+
218
+ The file needs to be made executable. You can run the following command.
219
+
220
+ <pre><code>chmod +x $HOME/Library/Caches/JetBrains/appland-plugin/appmap/3.164.0/appmap-macos-arm64</code></pre>
221
+
222
+ #### On Linux <!-- omit in toc -->
223
+
224
+ <pre><code>$HOME/.cache/JetBrains/appland-plugin/appmap/&lt;version&gt;/appmap-linux-arm64</code></pre>
225
+
226
+ Create the subdirectories if they don’t already exist.
227
+
228
+ For example:
229
+
230
+ <pre><code>$HOME/.cache/JetBrains/appland-plugin/appmap/3.164.0/appmap-linux-arm64</code></pre>
231
+
232
+ The file needs to be made executable. You can run the following command
233
+
234
+ <pre><code>chmod +x $HOME/.cache/JetBrains/appland-plugin/appmap/3.164.0/appmap-linux-arm64</code></pre>
235
+
236
+ #### On Windows <!-- omit in toc -->
237
+
238
+ <pre><code>%LocalAppData%\JetBrains\appland-plugin\appmap\&lt;version&gt;\appmap-win-x64.exe</code></pre>
239
+
240
+ Or the fully expanded path on windows.
241
+
242
+ <pre><code>C:\Users\&lt;YourUsername&gt;\AppData\Local\JetBrains\appland-plugin\appmap\&lt;version&gt;\appmap-win-x64.exe</code></pre>
243
+
244
+ Create the subdirectories if they don’t already exist.
245
+
246
+ For Example:
247
+
248
+ <pre><code>C:\Users\BobSmith\AppData\Local\JetBrains\appland-plugin\appmap\3.164.0\appmap-win-x64.exe</code></pre>
249
+
250
+ ### Install the AppMap Java Jar file
251
+
252
+ Copy the <code>appmap-&lt;version&gt;.jar</code> downloaded in the [previous step](#download-the-appmap-java-jar-file) to the following location. Ensure the file is renamed to `appmap.jar`
253
+
254
+ #### On Mac and Linux <!-- omit in toc -->
255
+
256
+ `$HOME/.appmap/lib/java/appmap.jar`
257
+
258
+ When recording your Java application, you will pass this file location to the JVM running your application like:
259
+
260
+ `-javaagent:~/.appmap/lib/java/appmap.jar`
261
+
262
+ #### On Windows <!-- omit in toc -->
263
+
264
+ `%USERPROFILE%\.appmap\lib\java\appmap.jar`
265
+
266
+ When recording your Java application, you will pass this file location to the JVM running your application like:
267
+ `-javaagent:%USERPROFILE%\.appmap\lib\java\appmap.jar`
268
+
269
+
270
+ ## Confirm Successful Installation
271
+
272
+ After completing the install steps, you can confirm the installation was done correctly by doing the following:
273
+
274
+ ### Open a Navie Chat
275
+
276
+ Follow the [getting started instructions](/docs/using-navie-ai/how-to-open-navie) to open a new Navie chat window.
277
+ If the AppMap binaries are installed and executable, you should see a new Navie chat window open successfully.
278
+
279
+ <img class="video-screenshot" src="/assets/img/docs/offline-install-14.webp"/>
280
+
281
+ If the binaries are not installed in the correct location, or are not executable, you will show a new Navie window prompt attempting to open but will hang until timeout.
282
+
283
+ <img class="video-screenshot" src="/assets/img/docs/offline-install-15.webp"/>
284
+
285
+ ### Record a Java Application
286
+
287
+ To test your Java Jar file is in the right location and working correctly, simply record a java application using the Java command flag.
288
+
289
+ Refer to the [AppMap Agent for Java](/docs/reference/appmap-java) documentation for more information about using the AppMap Jar for recording Java applications.
290
+
291
+ ```shell
292
+ $ java -javaagent:$HOME/.appmap/lib/java/appmap.jar -jar target/*.jar
293
+ ```
@@ -455,7 +455,7 @@ using the `--filter` option. Here are the steps for using this technique:
455
455
 
456
456
  1. Open an AppMap in the code editor.
457
457
  2. Use the filtering available in the AppMap to hide certain events. ![AppMap Filtering](/assets/img/docs/using_appmap_filter.jpg)
458
- 3. Open the command pallette using `CTRL+SHIFT+P` or `COMMAND+SHIFT+P` on macOS, type `AppMap: Copy Current AppMap State to Clipboard`, then hit `Enter`.
458
+ 3. Open the command palette using `CTRL+SHIFT+P` or `COMMAND+SHIFT+P` on macOS, type `AppMap: Copy Current AppMap State to Clipboard`, then hit `Enter`.
459
459
  4. Use the copied state as the `--filter` argument to the `prune` command. The `prune` command will remove whatever was filtered in the AppMap in your code editor.
460
460
 
461
461
  ```shell
@@ -218,7 +218,7 @@ attribute is ignored.
218
218
  The `appmap-java` annotations are provided in the package `com.appland:appmap-annotation`, available on [Maven Central](https://search.maven.org/artifact/com.appland/appmap-annotation). To use them, add that package as a dependency in your build configuration file (`pom.xml`, `build.gradle`).
219
219
 
220
220
  ### @Labels
221
- `appmap-java` suports the addition of [code labels](/docs/reference/appmap-java.html#annotations) through the `com.appland.appmap.annotation.Labels` annotation.
221
+ `appmap-java` supports the addition of [code labels](/docs/reference/appmap-java.html#annotations) through the `com.appland.appmap.annotation.Labels` annotation.
222
222
 
223
223
  #### Usage
224
224
  Once the `Labels` annotation is available, you can apply it to methods in your application. For example:
@@ -5,6 +5,7 @@ description: "Learn how to export your AppMap Diagrams into raw JSON format, SVG
5
5
  guides: true
6
6
  name: Exporting AppMap Diagrams
7
7
  step: 4
8
+ redirect_from: [/docs/guides/exporting-appmap-diagrams]
8
9
  ---
9
10
 
10
11
  # Exporting AppMap Diagrams <!-- omit in toc -->
@@ -5,7 +5,7 @@ description: "Learn how to manage large AppMap Diagrams effectively. Discover ti
5
5
  guides: true
6
6
  name: Handling Large AppMap Diagrams
7
7
  step: 4
8
- redirect_from: [/docs/reference/handling-large-appmaps, /docs/reference/guides/handling-large-appmaps]
8
+ redirect_from: [/docs/reference/handling-large-appmaps, /docs/reference/guides/handling-large-appmaps, /docs/guides/handling-large-appmap-diagrams]
9
9
  ---
10
10
 
11
11
  # Handling Large AppMap Diagrams <!-- omit in toc -->
@@ -3,6 +3,7 @@ layout: docs
3
3
  title: Docs - How-To Guides
4
4
  description: "Learn how to leverage AppMap effectively with guides on handling large AppMap Diagrams, reading SQL, refining, generating OpenAPI, reverse engineering, and more."
5
5
  step: 1
6
+ redirect_from: [/docs/guides]
6
7
  ---
7
8
 
8
9
  # How-To Guides
@@ -5,7 +5,7 @@ description: "Explore AppMap's Code Objects view to navigate code functions, HTT
5
5
  guides: true
6
6
  name: Navigating Code Objects
7
7
  step: 3
8
- redirect_from: [/docs/your-first-15-minutes-with-appmap/navigating-code-objects, /docs/setup-appmap-in-your-code-editor/navigating-code-objects]
8
+ redirect_from: [/docs/your-first-15-minutes-with-appmap/navigating-code-objects, /docs/setup-appmap-in-your-code-editor/navigating-code-objects, /docs/guides/navigating-code-objects]
9
9
  ---
10
10
 
11
11
  # Navigating Code Objects
@@ -36,7 +36,7 @@ There are three sections to the Code Objects view. The first section is the Code
36
36
 
37
37
  In the HTTP Service request list, you can see basically a mini spec file showing you what routes are available across all of your AppMap Diagrams.
38
38
 
39
- If this route only exists in a single AppMap, you’ll be taken directly to the AppMap for this request, but if the route exists in multiple diagrams you’ll get a VScode picker to choose which one to open.
39
+ If this route only exists in a single AppMap, you’ll be taken directly to the AppMap for this request, but if the route exists in multiple diagrams you’ll get a VSCode picker to choose which one to open.
40
40
 
41
41
  Here is this route, and here it is shown in a trace view, and you’ll see the status code for that is 302 which is a redirect.
42
42
 
@@ -5,7 +5,7 @@ description: "Use AppMap to auto generate OpenAPI definitions and document HTTP
5
5
  guides: true
6
6
  name: Generating OpenAPI Definitions
7
7
  step: 7
8
- redirect_from: [/docs/openapi,/docs/openapi/features,/docs/openapi/code-editor-extensions,/docs/openapi/integrations,/docs/openapi/customization,/docs/reference/openapi]
8
+ redirect_from: [/docs/guides/openapi, /docs/openapi,/docs/openapi/features,/docs/openapi/code-editor-extensions,/docs/openapi/integrations,/docs/openapi/customization,/docs/reference/openapi]
9
9
  ---
10
10
 
11
11
 
@@ -5,7 +5,7 @@ description: "Discover SQL commands in AppMap Diagrams to analyze application lo
5
5
  guides: true
6
6
  name: Reading SQL in AppMap Diagrams
7
7
  step: 5
8
- redirect_from: [/docs/reference/guides/reading-sql-in-appmaps]
8
+ redirect_from: [/docs/reference/guides/reading-sql-in-appmaps, /docs/guides/reading-sql-in-appmap-diagrams]
9
9
  ---
10
10
 
11
11
  ## Reading SQL in AppMap Diagrams
@@ -5,7 +5,7 @@ description: "Optimize AppMap Diagrams by refining recordings to exclude noise.
5
5
  guides: true
6
6
  name: Refining AppMap Data
7
7
  step: 6
8
- redirect_from: [/docs/reference/refine-appmaps, /docs/reference/guides/refine-appmaps]
8
+ redirect_from: [/docs/reference/refine-appmaps, /docs/reference/guides/refine-appmaps /docs/guides/refine-appmap-data]
9
9
  ---
10
10
 
11
11
  # Refining AppMap Data <!-- omit in toc -->
@@ -6,6 +6,7 @@ description: "Learn to reverse engineer efficiently using AppMap. Capture code e
6
6
  step: 9
7
7
  render_with_liquid: false
8
8
  name: Reverse Engineering
9
+ redirect_from: [/docs/guides/reverse-engineering]
9
10
  ---
10
11
 
11
12
  # Reverse Engineering with AppMap <!-- omit in toc -->
@@ -5,7 +5,7 @@ description: "Configure AppMap Analysis by customizing checks for flexible rule
5
5
  guides: true
6
6
  name: Using AppMap Analysis
7
7
  step: 8
8
- redirect_from: [/docs/analysis/configuring-checks, /docs/analysis/match-pattern-config, /docs/analysis/findings,/docs/reference/configuring-analysis,/docs/reference/guides/configuring-analysis, /docs/analysis]
8
+ redirect_from: [/docs/analysis/configuring-checks, /docs/analysis/match-pattern-config, /docs/analysis/findings,/docs/reference/configuring-analysis,/docs/reference/guides/configuring-analysis, /docs/analysis, /docs/guides/using-appmap-analysis]
9
9
  ---
10
10
 
11
11
  # AppMap Analysis
@@ -6,7 +6,7 @@ guides: true
6
6
  toc: true
7
7
  name: Using AppMap Diagrams
8
8
  step: 2
9
- redirect_from: [/docs/how-to-use-appmap-diagrams.html, /docs/how-to-use-appmap-diagrams, /docs/diagrams/how-to-use-appmaps, /docs/diagrams/sequence-diagrams, /docs/diagrams, /docs/diagrams/how-it-works, /docs/diagrams/dependency-map, /docs/diagrams/trace-view, /docs/diagrams/sequence-diagram, /docs/diagrams/flamegraph, /docs/setup-appmap-in-your-code-editor/navigating-appmap-diagrams]
9
+ redirect_from: [/docs/how-to-use-appmap-diagrams.html, /docs/how-to-use-appmap-diagrams, /docs/diagrams/how-to-use-appmaps, /docs/diagrams/sequence-diagrams, /docs/diagrams, /docs/diagrams/how-it-works, /docs/diagrams/dependency-map, /docs/diagrams/trace-view, /docs/diagrams/sequence-diagram, /docs/diagrams/flamegraph, /docs/setup-appmap-in-your-code-editor/navigating-appmap-diagrams, /docs/guides/using-appmap-diagrams]
10
10
  ---
11
11
 
12
12
  # Using AppMap Diagrams <!-- omit in toc -->
@@ -264,7 +264,7 @@ Flame Graphs make it easy to see how much time is spent in each function, and wh
264
264
 
265
265
  ### How to read a Flame Graph
266
266
 
267
- The lowest layer in a Flame Graph represents the AppMap Data recording, and it contains the recordings’s name. For an AppMap Flame Graph created from tests, this will usually be the same name as the test from which it was generated. In the example below, the AppMap was recorded from a test related to an application’s account activation capability.
267
+ The lowest layer in a Flame Graph represents the AppMap Data recording, and it contains the recording's name. For an AppMap Flame Graph created from tests, this will usually be the same name as the test from which it was generated. In the example below, the AppMap was recorded from a test related to an application’s account activation capability.
268
268
 
269
269
  ![flame graph image](/assets/img/docs/flamegraph-8.webp)
270
270
 
@@ -21,6 +21,8 @@ redirect_from: [/docs/reference/browser-extension]
21
21
  - [Remote recording API](/docs/reference/remote-recording-api)
22
22
  - [Analysis Rules](/docs/reference/analysis-rules)
23
23
  - [Analysis Labels](/docs/reference/analysis-labels)
24
+ - [License Key Installation](/docs/reference/license-key-install)
25
+ - [AppMap Offline Install for Secure Environments](/docs/reference/appmap-airgapped-install)
24
26
  - [Uninstalling AppMap](/docs/reference/uninstalling-appmap)
25
27
 
26
28
  ## Advanced AppMap Data Management
@@ -34,7 +36,7 @@ redirect_from: [/docs/reference/browser-extension]
34
36
  - [Using AppMap Analysis](/docs/reference/guides/using-appmap-analysis.html)
35
37
  - [Reverse Engineering](/docs/reference/guides/reverse-engineering.html)
36
38
 
37
- ## integrations
39
+ ## Integrations
38
40
 
39
41
  - [Atlassian Compass](/docs/reference/integrations/atlassian-compass.html)
40
42
  - [Atlassian Confluence](/docs/reference/integrations/atlassian-confluence.html)
@@ -5,6 +5,7 @@ description: "Atlassian Compass is a unified platform for managing distributed s
5
5
  integrations: true
6
6
  name: Atlassian Compass
7
7
  step: 1
8
+ redirect_from: [/docs/integrations/atlassian-compass]
8
9
  ---
9
10
 
10
11
  # Atlassian Compass
@@ -5,6 +5,7 @@ description: "AppMap integrates with Atlassian Confluence to generate interactiv
5
5
  integrations: true
6
6
  name: Atlassian Confluence
7
7
  step: 1
8
+ redirect_from: [/docs/integrations/atlassian-confluence]
8
9
  ---
9
10
 
10
11
  # Atlassian Confluence
@@ -5,6 +5,7 @@ description: "Learn how to record AppMap Data inside a Docker container for cons
5
5
  integrations: true
6
6
  name: Docker
7
7
  step: 7
8
+ redirect_from: [/docs/integrations/docker]
8
9
  ---
9
10
 
10
11
  # Docker
@@ -3,6 +3,7 @@ layout: docs
3
3
  title: Docs - Integrations
4
4
  description: "Explore how to integrate AppMap with popular services like Atlassian Compass, Confluence, GitHub Actions, CircleCI, PlantUML, Postman, SwaggerHub, Readme.com, and Docker"
5
5
  toc: false
6
+ redirect_from: [/docs/integrations]
6
7
  ---
7
8
 
8
9
  # Integrations
@@ -5,6 +5,7 @@ description: "Generate Mermaid diagrams with AppMap Navie. Download, edit, and s
5
5
  integrations: true
6
6
  name: Mermaid
7
7
  step: 4
8
+ redirect_from: [/docs/integrations/mermaid]
8
9
  ---
9
10
 
10
11
  # Mermaid