Skip to content

Commit 8c401a4

Browse files
dustinbyrnedustinbyrne
committed
fix: Update README.md
1 parent 7cbcb70 commit 8c401a4

File tree

1 file changed

+90
-50
lines changed

1 file changed

+90
-50
lines changed

‎README.md‎

Lines changed: 90 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -5,90 +5,130 @@
55

66
# AppMap for Visual Studio Code
77

8-
AppMap is a developer tools platform powered by runtime analysis and AI. It's composed of three components:
8+
### Runtime‑aware AI starts here
99

10-
* Navie - AI code architect.
11-
* AppMap data - Runtime traces of your application runtime.
12-
* AppMap diagrams - Interactive visualizations of AppMap data.
10+
#### **Live code behavior, surfaced to your AI tools in your JetBrains IDE**
1311

14-
Navie is the first AI code architect with the context to understand how your app works when it runs, like a principal engineer or software architect. AppMap data provides Navie with accurate information about application behavior, APIs, database queries, and more, providing valuable context so you can ask more challenging questions and get better answers.
12+
AppMap Navie for JetBrains brings the power of real-time execution data and AI-driven insights right
13+
to your code editor. No more guessing what your code does under the hood. Navie watches your
14+
application run and uses that live context to provide **smarter suggestions**, **faster debugging**,
15+
and **runtime-aware code reviews**.
1516

16-
![implement-redis](https://github.com/getappmap/vscode-appland/assets/511733/46243179-893e-474c-925a-91b385c3468d)
17+
## Key Benefits
1718

18-
## Get started
19-
1. **Install [the AppMap extension](https://marketplace.visualstudio.com/items?itemName=appland.appmap)** from within the code editor or from the marketplace.
19+
### Smarter AI assistance
2020

21-
2. **Sign in with an email address, or with GitHub or GitLab** and Navie will be available in `@explain` mode. This enables Navie to respond to general coding and development questions and answer questions about using AppMap data.
21+
Navie combines static analysis with live AppMap traces, so you can ask things like _"What just
22+
happened?"_ and get answers based on the actual runtime flow, HTTP calls, SQL queries, exceptions,
23+
I/O, and more.
2224

23-
3. **Ask Navie** for guidance recording AppMap data specific to interactions or code scenarios you're interested in analyzing.
24-
25+
### Faster debugging & fewer defects
2526

26-
## Examples
27-
[Here are some examples](https://appmap.io/product/examples/navie) of Navie making context-aware suggestions, providing tactical solutions, and reasoning about the larger context of the specific code being worked on.
27+
Pinpoint performance bottlenecks and logic errors through automatically generated sequence diagrams,
28+
flame graphs, dependency maps, and trace views.
2829

29-
## Chat Modes
30+
### Context‑aware code reviews
31+
32+
From security checks to maintainability recommendations, Navie’s `@review` mode analyzes your
33+
current branch changes against your base branch with runtime insights.
3034

31-
Navie provides different modes of interaction to assist you with your code and project. Here's a quick overview:
35+
### Zero fine‑tuning required
36+
37+
Works out-of-the-box with enterprise‑ready LLMs—simply plug in your API key or let Navie default to
38+
GitHub Copilot or AppMap’s built‑in endpoint.
39+
40+
![implement-redis](https://github.com/getappmap/vscode-appland/assets/511733/46243179-893e-474c-925a-91b385c3468d)
3241

33-
- **`@explain` (default)**: Navie makes context-aware suggestions, provides specific solutions, and reasons about the larger context of the specific code being worked on.
42+
## What AppMap Does
3443

35-
- **`@plan`**: Navie focuses the AI response on building a detailed implementation plan for the relevant query. This will focus Navie on only understanding the problem and the application to generate a step-by-step plan.
44+
- Captures real‑time snapshots of code execution, data flow, and behavior with zero effort and no
45+
code changes.
3646

37-
- **`@generate`**: Activate code generation mode by beginning any question with the prefix "@generate". In this mode Navie's response are optimized to include code snippets you can use directly in the files are working on.
47+
- Feeds runtime context to AI assistants like Navie, GitHub Copilot, Anthropic Claude, Google
48+
Gemini, OpenAI, and your own local LLMs.
3849

39-
- **`@test`**: Navie's responses are optimized for test case creation, such as unit testing or integration testing. This prefix will understand how your tests are currently written and provide updated tests based on features or code that is provided.
50+
- Delivers deep code explanations, diagrams, implementation plans, tests, and patch-ready code
51+
snippets, all grounded in what your application just did.
4052

41-
- **`@diagram`**: Navie will create and render a Mermaid compatible diagram within the Navie chat window. You can open this diagram in the [Mermaid Live Editor](https://mermaid.live), copy the Mermaid Definitions to your clipboard, save to disk, or expand a full window view.
53+
## Get started
54+
55+
1. **Install
56+
[the AppMap extension](https://marketplace.visualstudio.com/items?itemName=appland.appmap)** from
57+
within the code editor or from the marketplace.
58+
59+
2. **Sign in with an email address, or with GitHub or GitLab** and Navie will be available in
60+
`@explain` mode. This enables Navie to respond to general coding and development questions and
61+
answer questions about using AppMap data.
62+
63+
3. **Ask Navie** for guidance recording AppMap data specific to interactions or code scenarios
64+
you're interested in analyzing.
65+
66+
## Chat Modes
4267

43-
- **`@help`**: Activate help mode by beginning any question with the prefix "@help". This mode offers assistance with using AppMap, including guidance for generating and leveraging AppMap data effectively.
68+
Navie provides different modes of interaction for an efficient workflow and optimized results from
69+
AI-assisted coding.
4470

45-
**💡 Ask Navie - Using the lightbulb**: This feature is available in the Code Action menu when you have code selected. Choosing ‘Ask Navie’ from the Code Actions Menu initiates a new Navie chat populated with the snippet of selected code, enabling Navie answers based on that specific code snippet. Similarly, if you select some code in the active code window and open Navie, the selected code will be passed along.
71+
![Chat Modes](https://github.com/getappmap/vscode-appland/blob/master/images/command-palette-menu.jpg?raw=true)
4672

47-
**Ask Navie about a specific AppMap visualization**: You can target your question more specifically to an AppMap, representing a test case, API call, or other interaction by clicking the “Ask Navie” box on any AppMap you open.
73+
- **`@explain` (default)**: Navie makes context-aware suggestions, provides specific solutions, and
74+
reasons about the larger context of the specific code being worked on.
4875

49-
## Bring your own key or model for Navie
76+
- **`@plan`**: Navie focuses the AI response on building a detailed implementation plan for the
77+
relevant query. This will focus Navie on only understanding the problem and the application to
78+
generate a step-by-step plan.
5079

51-
In order to configure Navie for your own LLM, certain environment variables need to be set for AppMap services. Refer to the [AppMap documentation](https://appmap.io/docs/navie/bring-your-own-model.html) for details on how to do that.
80+
- **`@generate`**: Activate code generation mode by beginning any question with the prefix
81+
"@generate". In this mode Navie's response are optimized to include code snippets you can use
82+
directly in the files are working on.
5283

53-
## Creating AppMap Data
84+
- **`@test`**: Navie's responses are optimized for test case creation, such as unit testing or
85+
integration testing. This prefix will understand how your tests are currently written and provide
86+
updated tests based on features or code that is provided.
5487

55-
Ask Navie to guide you through the process of making AppMap data, or navigate to the Record AppMaps screen in your code editor.
88+
- **`@diagram`**: Navie will create and render a Mermaid compatible diagram within the Navie chat
89+
window. You can open this diagram in the [Mermaid Live Editor](https://mermaid.live), copy the
90+
Mermaid Definitions to your clipboard, save to disk, or expand a full window view.
5691

57-
You’ll start by configuring the AppMap language library for your project. Then you’ll make a recording of the code you are working on by running your application in your development environment with AppMap enabled. AppMap data files will automatically be generated and stored on your local file system.
92+
- **`@search`**: By leveraging smart search capabilities, this command will locate specific code
93+
elements, relevant modules, or examples.
5894

59-
Once you’ve recorded AppMap data, Navie's awareness of your application’s behavior and code will be significantly upgraded.
95+
- **`@review`**: This command will review the code changes on your current branch and provide
96+
actionable insights on various aspects of code, ensuring alignment with best practices in areas
97+
such as code quality, security, and maintainability.
6098

61-
Using AppMap data Navie can:
62-
* Explain code or application behavior, including queries, web service requests, and more.
63-
* Make code suggestions like a senior software developer.
64-
* Find the potential performance problems or dynamic security flaws in existing or newly written code.
65-
* Help you document application behavior changes for a PR.
66-
* Navie’s code recommendations span multiple files, functions, APIs, databases, and more.
99+
- **`@help`**: Activate help mode by beginning any question with the prefix "@help". This mode
100+
offers assistance with using AppMap, including guidance for generating and leveraging AppMap data
101+
effectively.
67102

68-
Naive answers are backed up by references to AppMap data. Naive presents this data alongside the chat discussion, and you can also open and use AppMap diagrams independently of Navie.
103+
## Pinned Context
69104

70-
AppMap diagrams include:
105+
Pin specific data files to your conversation with Navie to include data sources you know are
106+
relevant to the issue. This includes pinning the text of the issue itself, and Navie responses.
71107

72-
* **Sequence Diagrams** to follow the runtime flow of calls made by your application.
73-
* **Dependency Maps** to see which libraries and frameworks were used at runtime.
74-
* **Flame Graphs** to spot performance issues and bottlenecks.
75-
* **Trace Views** to perform detailed function call and data flow tracing.
108+
![Pinned Context](https://github.com/getappmap/vscode-appland/blob/master/images/pinned-context.jpg?raw=true)
76109

77-
![appmap-visualizations-2](https://github.com/getappmap/vscode-appland/assets/1229326/13cb6ecc-8ee6-4d3e-8f26-d7bd2ecd9b22)
110+
## Making AppMap Data
78111

79-
#### Requirements for making AppMap data
112+
You can improve the quality and accuracy of Navie AI by
113+
[making AppMap Data for your project](https://appmap.io/docs/get-started-with-appmap/making-appmap-data.html).
80114

81-
Supported programming languages: Node.js, Java (+ Kotlin), Ruby, and Python.
82-
AppMap works particularly well with web application frameworks such as: Nest.js, Next.js, Spring, Ruby on Rails, Django, and Flask.
115+
#### Documentation
83116

84-
To start making AppMap data, you’ll need to install and configure the AppMap client agent for your project.
117+
Navie is an open-source extension built with enterprise needs in mind, delivering a flexible LLM
118+
backend that allows organizations to fine-tune their AI solutions at scale. With advanced features
119+
like customizable token limits, robust automation tools, and seamless integration with existing
120+
workflows.
85121

86-
Make AppMap data by running your app—either by [running test cases](https://appmap.io/docs/recording-methods.html#recording-test-cases), or by [recording a short interaction with your app](https://appmap.io/docs/recording-methods.html#remote-recording).
122+
For detailed information [visit our documentation](https://appmap.io/docs/appmap-docs.html).
87123

88124
## Licensing and Security
89125

90-
[Open source MIT license](https://github.com/getappmap/vscode-appland/blob/master/LICENSE) | [Terms and conditions](https://appmap.io/community/terms-and-conditions.html)
126+
[Open source MIT license](https://github.com/getappmap/vscode-appland/blob/master/LICENSE) |
127+
[Terms and conditions](https://appmap.io/community/terms-and-conditions.html)
91128

92-
To learn more about security of AppMap, or the use of data with AI when using Navie, see the AppMap [security disclosure](https://appmap.io/security) for more detailed information and discussion.
129+
To learn more about security of AppMap, or the use of data with AI when using Navie, see the AppMap
130+
[security disclosure](https://appmap.io/security) for more detailed information and discussion.
93131

94-
There is [no fee](https://appmap.io/pricing) for personal use of AppMap for graphing and limited Navie use. Pricing for premium features and integrations are listed on [AppMap’s Pricing Page](https://appmap.io/pricing).
132+
There is [no fee](https://appmap.io/pricing) for personal use of AppMap for graphing and limited
133+
Navie use. Pricing for premium features and integrations are listed on
134+
[AppMap’s Pricing Page](https://appmap.io/pricing).

0 commit comments

Comments
 (0)