Using a framework we don't support yet? Let us know in Slack!
Open a terminal window in the root of your project and paste in this command:
npx @appland/appmap install
You will be guided through a series of steps for installing and configuring that agent, that will look like this:
$ npx @appland/appmap install ... ✔ Installing the AppMap agent... ✔ Validating the AppMap agent... ╭───────────────────────────────────────────────────────────────╮ │ │ │ Success! The AppMap agent has been installed. │ │ │ │ Run your tests with npx appmap-agent-js -- "test command" │ │ By default, AppMap files will be output to target/appmap │ │ │ │ For more information, visit │ │ https://appland.com/docs/reference/appmap-java │ │ │ ╰───────────────────────────────────────────────────────────────╯
After you have installed the agent proceed to Record AppMaps.
For installation without Node.js follow this manual installation procedure.
@appland/appmap-agent-js package to the
package.json file of your project with
npm install @appland/appmap-agent-js
appmap.ymlin the root folder of your project
Add your application modules and source (or binary) folders to appmap.yml
name: MyApp packages: - path: src/controllers - path: src/data - path: src/lib - path: src/models - path: src/routes
name: MyApp packages: - path: dist/controllers - path: dist/data - path: dist/lib - path: dist/models - path: dist/routes
If you aren’t sure which option to take, start with both source and build folders and optimize the
appmap.yml file later.