@appland/appmap 3.133.0 → 3.135.0

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+# [@appland/appmap-v3.135.0](https://github.com/getappmap/appmap-js/compare/@appland/appmap-v3.134.0...@appland/appmap-v3.135.0) (2024-03-26)
+
+
+### Features
+
+* Update @appland/navie ([084b446](https://github.com/getappmap/appmap-js/commit/084b446cf7f1b8ed596d7d0eee2d9b86d13451a4))
+
+# [@appland/appmap-v3.134.0](https://github.com/getappmap/appmap-js/compare/@appland/appmap-v3.133.0...@appland/appmap-v3.134.0) (2024-03-26)
+
+
+### Bug Fixes
+
+* Default the stats name to the directory ([b1351b1](https://github.com/getappmap/appmap-js/commit/b1351b139a2e06e154e134933fc3ff47c0c98729))
+
+
+### Features
+
+* Implement [@help](https://github.com/help) mode ([58f36f3](https://github.com/getappmap/appmap-js/commit/58f36f392b875bbd6a8301f68ecb18c505d2bb97))
+* Refactor navie into agent modes ([2b1a7f6](https://github.com/getappmap/appmap-js/commit/2b1a7f65e828332eb1e38cac12f85c8aff833880))
+
 # [@appland/appmap-v3.133.0](https://github.com/getappmap/appmap-js/compare/@appland/appmap-v3.132.0...@appland/appmap-v3.133.0) (2024-03-26)
 
 

package/built/cmds/index/index.js

@@ -91,8 +91,8 @@ const handler = async (argv) => {
                 (0, console_1.log)(`--navie-provider option not provided, and none of ${AI_KEY_ENV_VARS.join(' ')} are available. Using remote Navie provider.`);
                 return false;
             };
-            const buildLocalNavie = (threadId, contextProvider, projectInfoProvider) => {
-                const navie = new navie_local_1.default(threadId, contextProvider, projectInfoProvider);
+            const buildLocalNavie = (threadId, contextProvider, projectInfoProvider, helpProvider) => {
+                const navie = new navie_local_1.default(threadId, contextProvider, projectInfoProvider, helpProvider);
                 let START;
                 const logEvent = (event) => {
                     if (!logNavie)
@@ -107,7 +107,7 @@ const handler = async (argv) => {
                 navie.on('event', logEvent);
                 return navie;
             };
-            const buildRemoteNavie = (threadId, contextProvider, projectInfoProvider) => new navie_remote_1.default(threadId, contextProvider, projectInfoProvider);
+            const buildRemoteNavie = (threadId, contextProvider, projectInfoProvider, helpProvider) => new navie_remote_1.default(threadId, contextProvider, projectInfoProvider, helpProvider);
             const navieProvider = useLocalNavie() ? buildLocalNavie : buildRemoteNavie;
             (0, handleWorkingDirectory_1.configureRpcDirectories)([process.cwd()]);
             const rpcMethods = [

package/built/cmds/index/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/cmds/index/index.ts"],"names":[],"mappings":";;;;;;AAAA,wDAAgC;AAEhC,kDAA0B;AAE1B,gHAAwF;AACxF,wGAAgF;AAChF,6EAAmG;AACnG,+DAA4D;AAC5D,uCAAsC;AACtC,qCAAoC;AACpC,+DAA4D;AAC5D,oDAAiD;AACjD,qEAAmD;AAEnD,yEAAiD;AACjD,uFAA+D;AAC/D,uDAAiF;AACjF,4DAAoC;AACpC,iEAA+C;AAC/C,4CAAoD;AACpD,kDAAsE;AACtE,sFAA6D;AAC7D,wFAA+D;AAI/D,MAAM,eAAe,GAAG,CAAC,gBAAgB,CAAC,CAAC;AAE9B,QAAA,OAAO,GAAG,OAAO,CAAC;AAClB,QAAA,QAAQ,GACnB,4EAA4E,CAAC;AAExE,MAAM,OAAO,GAAG,CAAC,IAAgB,EAAE,EAAE;IAC1C,IAAI,CAAC,UAAU,EAAE,CAAC;IAElB,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE;QACvB,QAAQ,EAAE,2BAA2B;QACrC,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;KACX,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;QACxB,QAAQ,EAAE,8CAA8C;KACzD,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;QACnB,QAAQ,EAAE,4CAA4C;QACtD,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,GAAG;KACX,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;QAClB,QAAQ,EAAE,yCAAyC;QACnD,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;KACX,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE;QAC5B,QAAQ,EAAE,uBAAuB;QACjC,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;KAC7B,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE;QACvB,QAAQ,EAAE,4BAA4B;QACtC,OAAO,EAAE,IAAI;QACb,OAAO,EAAE,KAAK;KACf,CAAC,CAAC;IAEH,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;AACvB,CAAC,CAAC;AAjCW,QAAA,OAAO,WAiClB;AAEK,MAAM,OAAO,GAAG,KAAK,EAAE,IAAI,EAAE,EAAE;IACpC,IAAA,eAAO,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACtB,IAAA,+CAAsB,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACvC,MAAM,SAAS,GAAG,MAAM,IAAA,iCAAe,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAExD,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;IAEvC,MAAM,SAAS,GAAG,KAAK,IAAI,IAAI,KAAK,SAAS,CAAC;IAC9C,IAAI,IAAI,IAAI,CAAC,KAAK;QAAE,IAAA,cAAI,EAAC,qCAAqC,CAAC,CAAC;IAEhE,IAAI,SAAS,EAAE;QACb,IAAA,0BAAiB,EAAC,KAAK,CAAC,CAAC;QAEzB,IAAA,aAAG,EAAC,+BAA+B,CAAC,CAAC;QACrC,MAAM,GAAG,GAAG,IAAI,iCAAuB,CAAC,SAAS,CAAC,CAAC;QACnD,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;QAEpB,IAAI,IAAI,KAAK,SAAS,EAAE;YACtB,MAAM,aAAa,GAAG,GAAG,EAAE;gBACzB,IAAI,IAAI,CAAC,aAAa,KAAK,OAAO,EAAE;oBAClC,IAAA,aAAG,EAAC,0EAA0E,CAAC,CAAC;oBAChF,OAAO,IAAI,CAAC;iBACb;gBAED,IAAI,IAAI,CAAC,aAAa,KAAK,QAAQ,EAAE;oBACnC,IAAA,aAAG,EAAC,4EAA4E,CAAC,CAAC;oBAClF,OAAO,KAAK,CAAC;iBACd;gBAED,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;gBACvF,IAAI,QAAQ,EAAE;oBACZ,IAAA,aAAG,EAAC,sEAAsE,QAAQ,EAAE,CAAC,CAAC;oBACtF,OAAO,IAAI,CAAC;iBACb;gBAED,IAAA,aAAG,EACD,qDAAqD,eAAe,CAAC,IAAI,CACvE,GAAG,CACJ,8CAA8C,CAChD,CAAC;gBACF,OAAO,KAAK,CAAC;YACf,CAAC,CAAC;YAEF,MAAM,eAAe,GAAG,CACtB,QAA4B,EAC5B,eAAwC,EACxC,mBAAoD,EACpD,EAAE;gBACF,MAAM,KAAK,GAAG,IAAI,qBAAU,CAAC,QAAQ,EAAE,eAAe,EAAE,mBAAmB,CAAC,CAAC;gBAE7E,IAAI,KAAyB,CAAC;gBAE9B,MAAM,QAAQ,GAAG,CAAC,KAAuB,EAAE,EAAE;oBAC3C,IAAI,CAAC,QAAQ;wBAAE,OAAO;oBAEtB,IAAI,CAAC,KAAK;wBAAE,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBAE/B,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;oBACnC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,eAAK,CAAC,IAAI,CAAC,GAAG,OAAO,KAAK,CAAC,CAAC,CAAC;oBAClD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,eAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;oBAChD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;gBACzC,CAAC,CAAC;gBAEF,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC5B,OAAO,KAAK,CAAC;YACf,CAAC,CAAC;YACF,MAAM,gBAAgB,GAAG,CACvB,QAA4B,EAC5B,eAAwC,EACxC,mBAAoD,EACpD,EAAE,CAAC,IAAI,sBAAW,CAAC,QAAQ,EAAE,eAAe,EAAE,mBAAmB,CAAC,CAAC;YAErE,MAAM,aAAa,GAAG,aAAa,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,gBAAgB,CAAC;YAE3E,IAAA,gDAAuB,EAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YAEzC,MAAM,UAAU,GAA2B;gBACzC,IAAA,2BAAY,EAAC,GAAG,CAAC;gBACjB,IAAA,eAAM,GAAE;gBACR,IAAA,qBAAa,GAAE;gBACf,IAAA,qBAAa,GAAE;gBACf,IAAA,gBAAY,GAAE;gBACd,IAAA,cAAU,GAAE;gBACZ,IAAA,kBAAQ,GAAE;gBACV,IAAA,yBAAe,GAAE;gBACjB,IAAA,wBAAc,EAAC,aAAa,CAAC;gBAC7B,IAAA,8BAAoB,GAAE;aACvB,CAAC;YACF,MAAM,SAAS,GAAG,IAAI,mBAAS,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAClD,SAAS,CAAC,KAAK,EAAE,CAAC;SACnB;aAAM;YACL,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE;gBACzC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;gBAClC,MAAM,YAAY,GAAG,sBAAsB,CAAC;gBAC5C,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;gBACnC,WAAW,CAAC,GAAG,EAAE;oBACf,kBAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;oBAC3D,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC;gBAC9C,CAAC,EAAE,IAAI,CAAC,CAAC;aACV;SACF;KACF;SAAM;QACL,MAAM,GAAG,GAAG,IAAI,qCAA2B,CAAC,SAAS,CAAC,CAAC;QACvD,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;KACrB;AACH,CAAC,CAAC;AAzGW,QAAA,OAAO,WAyGlB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/cmds/index/index.ts"],"names":[],"mappings":";;;;;;AAAA,wDAAgC;AAEhC,kDAA0B;AAE1B,gHAAwF;AACxF,wGAAgF;AAChF,6EAAmG;AACnG,+DAA4D;AAC5D,uCAAsC;AACtC,qCAAoC;AACpC,+DAA4D;AAC5D,oDAAiD;AACjD,qEAAmD;AAEnD,yEAAiD;AACjD,uFAA+D;AAC/D,uDAAiF;AACjF,4DAAoC;AACpC,iEAA+C;AAC/C,4CAAoD;AACpD,kDAAsE;AACtE,sFAA6D;AAC7D,wFAA+D;AAI/D,MAAM,eAAe,GAAG,CAAC,gBAAgB,CAAC,CAAC;AAE9B,QAAA,OAAO,GAAG,OAAO,CAAC;AAClB,QAAA,QAAQ,GACnB,4EAA4E,CAAC;AAExE,MAAM,OAAO,GAAG,CAAC,IAAgB,EAAE,EAAE;IAC1C,IAAI,CAAC,UAAU,EAAE,CAAC;IAElB,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE;QACvB,QAAQ,EAAE,2BAA2B;QACrC,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;KACX,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;QACxB,QAAQ,EAAE,8CAA8C;KACzD,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;QACnB,QAAQ,EAAE,4CAA4C;QACtD,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,GAAG;KACX,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;QAClB,QAAQ,EAAE,yCAAyC;QACnD,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;KACX,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE;QAC5B,QAAQ,EAAE,uBAAuB;QACjC,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;KAC7B,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE;QACvB,QAAQ,EAAE,4BAA4B;QACtC,OAAO,EAAE,IAAI;QACb,OAAO,EAAE,KAAK;KACf,CAAC,CAAC;IAEH,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;AACvB,CAAC,CAAC;AAjCW,QAAA,OAAO,WAiClB;AAEK,MAAM,OAAO,GAAG,KAAK,EAAE,IAAI,EAAE,EAAE;IACpC,IAAA,eAAO,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACtB,IAAA,+CAAsB,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACvC,MAAM,SAAS,GAAG,MAAM,IAAA,iCAAe,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAExD,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;IAEvC,MAAM,SAAS,GAAG,KAAK,IAAI,IAAI,KAAK,SAAS,CAAC;IAC9C,IAAI,IAAI,IAAI,CAAC,KAAK;QAAE,IAAA,cAAI,EAAC,qCAAqC,CAAC,CAAC;IAEhE,IAAI,SAAS,EAAE;QACb,IAAA,0BAAiB,EAAC,KAAK,CAAC,CAAC;QAEzB,IAAA,aAAG,EAAC,+BAA+B,CAAC,CAAC;QACrC,MAAM,GAAG,GAAG,IAAI,iCAAuB,CAAC,SAAS,CAAC,CAAC;QACnD,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;QAEpB,IAAI,IAAI,KAAK,SAAS,EAAE;YACtB,MAAM,aAAa,GAAG,GAAG,EAAE;gBACzB,IAAI,IAAI,CAAC,aAAa,KAAK,OAAO,EAAE;oBAClC,IAAA,aAAG,EAAC,0EAA0E,CAAC,CAAC;oBAChF,OAAO,IAAI,CAAC;iBACb;gBAED,IAAI,IAAI,CAAC,aAAa,KAAK,QAAQ,EAAE;oBACnC,IAAA,aAAG,EAAC,4EAA4E,CAAC,CAAC;oBAClF,OAAO,KAAK,CAAC;iBACd;gBAED,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;gBACvF,IAAI,QAAQ,EAAE;oBACZ,IAAA,aAAG,EAAC,sEAAsE,QAAQ,EAAE,CAAC,CAAC;oBACtF,OAAO,IAAI,CAAC;iBACb;gBAED,IAAA,aAAG,EACD,qDAAqD,eAAe,CAAC,IAAI,CACvE,GAAG,CACJ,8CAA8C,CAChD,CAAC;gBACF,OAAO,KAAK,CAAC;YACf,CAAC,CAAC;YAEF,MAAM,eAAe,GAAG,CACtB,QAA4B,EAC5B,eAAwC,EACxC,mBAAoD,EACpD,YAA+B,EAC/B,EAAE;gBACF,MAAM,KAAK,GAAG,IAAI,qBAAU,CAAC,QAAQ,EAAE,eAAe,EAAE,mBAAmB,EAAE,YAAY,CAAC,CAAC;gBAE3F,IAAI,KAAyB,CAAC;gBAE9B,MAAM,QAAQ,GAAG,CAAC,KAAuB,EAAE,EAAE;oBAC3C,IAAI,CAAC,QAAQ;wBAAE,OAAO;oBAEtB,IAAI,CAAC,KAAK;wBAAE,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBAE/B,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;oBACnC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,eAAK,CAAC,IAAI,CAAC,GAAG,OAAO,KAAK,CAAC,CAAC,CAAC;oBAClD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,eAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;oBAChD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;gBACzC,CAAC,CAAC;gBAEF,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC5B,OAAO,KAAK,CAAC;YACf,CAAC,CAAC;YACF,MAAM,gBAAgB,GAAG,CACvB,QAA4B,EAC5B,eAAwC,EACxC,mBAAoD,EACpD,YAA+B,EAC/B,EAAE,CAAC,IAAI,sBAAW,CAAC,QAAQ,EAAE,eAAe,EAAE,mBAAmB,EAAE,YAAY,CAAC,CAAC;YAEnF,MAAM,aAAa,GAAG,aAAa,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,gBAAgB,CAAC;YAE3E,IAAA,gDAAuB,EAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YAEzC,MAAM,UAAU,GAA2B;gBACzC,IAAA,2BAAY,EAAC,GAAG,CAAC;gBACjB,IAAA,eAAM,GAAE;gBACR,IAAA,qBAAa,GAAE;gBACf,IAAA,qBAAa,GAAE;gBACf,IAAA,gBAAY,GAAE;gBACd,IAAA,cAAU,GAAE;gBACZ,IAAA,kBAAQ,GAAE;gBACV,IAAA,yBAAe,GAAE;gBACjB,IAAA,wBAAc,EAAC,aAAa,CAAC;gBAC7B,IAAA,8BAAoB,GAAE;aACvB,CAAC;YACF,MAAM,SAAS,GAAG,IAAI,mBAAS,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAClD,SAAS,CAAC,KAAK,EAAE,CAAC;SACnB;aAAM;YACL,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE;gBACzC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;gBAClC,MAAM,YAAY,GAAG,sBAAsB,CAAC;gBAC5C,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;gBACnC,WAAW,CAAC,GAAG,EAAE;oBACf,kBAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;oBAC3D,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC;gBAC9C,CAAC,EAAE,IAAI,CAAC,CAAC;aACV;SACF;KACF;SAAM;QACL,MAAM,GAAG,GAAG,IAAI,qCAA2B,CAAC,SAAS,CAAC,CAAC;QACvD,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;KACrB;AACH,CAAC,CAAC;AA3GW,QAAA,OAAO,WA2GlB"}

package/built/cmds/index/rpc.js

@@ -20,19 +20,19 @@ const navie_remote_1 = __importDefault(require("../../rpc/explain/navie/navie-re
 const handleWorkingDirectory_1 = require("../../lib/handleWorkingDirectory");
 const client_1 = require("@appland/client");
 const configuration_1 = require("../../rpc/configuration");
+const navie_1 = require("@appland/navie");
 const AI_KEY_ENV_VARS = ['OPENAI_API_KEY'];
 exports.command = 'rpc';
 exports.describe = 'Run AppMap JSON-RPC server';
 const builder = (args) => {
-    args.showHidden();
     args.option('directory', {
         describe: 'program working directory',
         type: 'string',
         alias: 'd',
-        multiple: true,
+        array: true,
     });
     args.option('port', {
-        describe: 'port to listen on for JSON-RPC requests',
+        describe: 'port to listen on for JSON-RPC requests. Use port 0 to let the OS choose a port. The port number will be printed to stdout on startup.',
         type: 'number',
         alias: 'p',
     });
@@ -51,6 +51,10 @@ const builder = (args) => {
         type: 'string',
         array: true,
     });
+    args.option('agent-mode', {
+        describe: `Agent mode which to run the Navie AI. The agent can also be controlled by starting the question with '@<agent> '.`,
+        choices: Object.values(navie_1.Agents).map((agent) => agent.toLowerCase()),
+    });
     return args.strict();
 };
 exports.builder = builder;
@@ -67,6 +71,10 @@ const handler = async (argv) => {
     if (aiOptions) {
         aiOptions = Array.isArray(aiOptions) ? aiOptions : [aiOptions];
     }
+    let agentModeStr = argv.explainMode;
+    let agentMode;
+    if (agentModeStr)
+        agentMode = agentModeStr;
     const useLocalNavie = () => {
         if (argv.navieProvider === 'local') {
             (0, console_1.log)(`Using local Navie provider due to explicit --navie-provider=local option`);
@@ -93,9 +101,12 @@ const handler = async (argv) => {
                 }
             }
         }
+        if (agentMode) {
+            navie.setOption('explainMode', agentMode);
+        }
     };
-    const buildLocalNavie = (threadId, contextProvider, projectInfoProvider) => {
-        const navie = new navie_local_1.default(threadId, contextProvider, projectInfoProvider);
+    const buildLocalNavie = (threadId, contextProvider, projectInfoProvider, helpProvider) => {
+        const navie = new navie_local_1.default(threadId, contextProvider, projectInfoProvider, helpProvider);
         applyAIOptions(navie);
         let START;
         const logEvent = (event) => {
@@ -111,9 +122,9 @@ const handler = async (argv) => {
         navie.on('event', logEvent);
         return navie;
     };
-    const buildRemoteNavie = (threadId, contextProvider, projectInfoProvider) => {
+    const buildRemoteNavie = (threadId, contextProvider, projectInfoProvider, helpProvider) => {
         (0, client_1.loadConfiguration)(false);
-        const navie = new navie_remote_1.default(threadId, contextProvider, projectInfoProvider);
+        const navie = new navie_remote_1.default(threadId, contextProvider, projectInfoProvider, helpProvider);
         applyAIOptions(navie);
         return navie;
     };

package/built/cmds/index/rpc.js.map

@@ -1 +1 @@
-{"version":3,"file":"rpc.js","sourceRoot":"","sources":["../../../src/cmds/index/rpc.ts"],"names":[],"mappings":";;;;;;AACA,kDAA0B;AAE1B,uCAAsC;AACtC,qCAA8B;AAC9B,oDAAiD;AACjD,qEAAmD;AAEnD,yEAAiD;AACjD,uFAA+D;AAC/D,uDAAiF;AACjF,4DAAoC;AACpC,iEAA+C;AAC/C,kDAAsE;AACtE,sFAA6D;AAC7D,wFAA+D;AAG/D,6EAA2E;AAC3E,4CAAoD;AACpD,2DAAiF;AAEjF,MAAM,eAAe,GAAG,CAAC,gBAAgB,CAAC,CAAC;AAE9B,QAAA,OAAO,GAAG,KAAK,CAAC;AAChB,QAAA,QAAQ,GAAG,4BAA4B,CAAC;AAE9C,MAAM,OAAO,GAAG,CAAC,IAAgB,EAAE,EAAE;IAC1C,IAAI,CAAC,UAAU,EAAE,CAAC;IAElB,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE;QACvB,QAAQ,EAAE,2BAA2B;QACrC,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,IAAI;KACf,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;QAClB,QAAQ,EAAE,yCAAyC;QACnD,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;KACX,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE;QAC5B,QAAQ,EAAE,uBAAuB;QACjC,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;KAC7B,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE;QACvB,QAAQ,EAAE,4BAA4B;QACtC,OAAO,EAAE,IAAI;QACb,OAAO,EAAE,KAAK;KACf,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE;QACvB,QAAQ,EACN,kGAAkG;QACpG,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,IAAI;KACZ,CAAC,CAAC;IAEH,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;AACvB,CAAC,CAAC;AAhCW,QAAA,OAAO,WAgClB;AAEK,MAAM,OAAO,GAAG,KAAK,EAAE,IAAI,EAAE,EAAE;IACpC,IAAA,eAAO,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAEtB,IAAI,WAAW,GAAa,EAAE,CAAC;IAC/B,IAAI,IAAI,CAAC,SAAS,EAAE;QAClB,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC;YAC3B,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC;YACrC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;KACtC;IAED,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;IAChC,IAAI,SAAS,GAAyB,IAAI,CAAC,QAAQ,CAAC;IACpD,IAAI,SAAS,EAAE;QACb,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;KAChE;IAED,MAAM,aAAa,GAAG,GAAG,EAAE;QACzB,IAAI,IAAI,CAAC,aAAa,KAAK,OAAO,EAAE;YAClC,IAAA,aAAG,EAAC,0EAA0E,CAAC,CAAC;YAChF,OAAO,IAAI,CAAC;SACb;QAED,IAAI,IAAI,CAAC,aAAa,KAAK,QAAQ,EAAE;YACnC,IAAA,aAAG,EAAC,4EAA4E,CAAC,CAAC;YAClF,OAAO,KAAK,CAAC;SACd;QAED,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;QACvF,IAAI,QAAQ,EAAE;YACZ,IAAA,aAAG,EAAC,sEAAsE,QAAQ,EAAE,CAAC,CAAC;YACtF,OAAO,IAAI,CAAC;SACb;QAED,IAAA,aAAG,EACD,qDAAqD,eAAe,CAAC,IAAI,CACvE,GAAG,CACJ,8CAA8C,CAChD,CAAC;QACF,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,MAAM,cAAc,GAAG,CAAC,KAA+B,EAAE,EAAE;QACzD,IAAI,SAAS,EAAE;YACb,KAAK,MAAM,MAAM,IAAI,SAAS,EAAE;gBAC9B,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACvC,IAAI,GAAG,IAAI,KAAK,EAAE;oBAChB,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;iBAC7B;aACF;SACF;IACH,CAAC,CAAC;IAEF,MAAM,eAAe,GAAG,CACtB,QAA4B,EAC5B,eAAwC,EACxC,mBAAoD,EACpD,EAAE;QACF,MAAM,KAAK,GAAG,IAAI,qBAAU,CAAC,QAAQ,EAAE,eAAe,EAAE,mBAAmB,CAAC,CAAC;QAC7E,cAAc,CAAC,KAAK,CAAC,CAAC;QAEtB,IAAI,KAAyB,CAAC;QAC9B,MAAM,QAAQ,GAAG,CAAC,KAAuB,EAAE,EAAE;YAC3C,IAAI,CAAC,QAAQ;gBAAE,OAAO;YAEtB,IAAI,CAAC,KAAK;gBAAE,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAE/B,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;YACnC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,eAAK,CAAC,IAAI,CAAC,GAAG,OAAO,KAAK,CAAC,CAAC,CAAC;YAClD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,eAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;YAChD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACzC,CAAC,CAAC;QAEF,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAC5B,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,MAAM,gBAAgB,GAAG,CACvB,QAA4B,EAC5B,eAAwC,EACxC,mBAAoD,EACpD,EAAE;QACF,IAAA,0BAAiB,EAAC,KAAK,CAAC,CAAC;QACzB,MAAM,KAAK,GAAG,IAAI,sBAAW,CAAC,QAAQ,EAAE,eAAe,EAAE,mBAAmB,CAAC,CAAC;QAC9E,cAAc,CAAC,KAAK,CAAC,CAAC;QACtB,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,MAAM,aAAa,GAAG,aAAa,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,gBAAgB,CAAC;IAE3E,IAAA,gDAAuB,EAAC,WAAW,CAAC,CAAC;IAErC,MAAM,UAAU,GAA2B;QACzC,IAAA,eAAM,GAAE;QACR,IAAA,qBAAa,GAAE;QACf,IAAA,qBAAa,GAAE;QACf,IAAA,gBAAY,GAAE;QACd,IAAA,cAAU,GAAE;QACZ,IAAA,kBAAQ,GAAE;QACV,IAAA,yBAAe,GAAE;QACjB,IAAA,wBAAc,EAAC,aAAa,CAAC;QAC7B,IAAA,8BAAoB,GAAE;QACtB,IAAA,kCAAkB,GAAE;QACpB,IAAA,kCAAkB,GAAE;KACrB,CAAC;IACF,MAAM,SAAS,GAAG,IAAI,mBAAS,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAClD,SAAS,CAAC,KAAK,EAAE,CAAC;AACpB,CAAC,CAAC;AA1GW,QAAA,OAAO,WA0GlB"}
+{"version":3,"file":"rpc.js","sourceRoot":"","sources":["../../../src/cmds/index/rpc.ts"],"names":[],"mappings":";;;;;;AACA,kDAA0B;AAE1B,uCAAsC;AACtC,qCAA8B;AAC9B,oDAAiD;AACjD,qEAAmD;AAEnD,yEAAiD;AACjD,uFAA+D;AAC/D,uDAAiF;AACjF,4DAAoC;AACpC,iEAA+C;AAC/C,kDAAsE;AACtE,sFAA6D;AAC7D,wFAA+D;AAG/D,6EAA2E;AAC3E,4CAAoD;AACpD,2DAAiF;AACjF,0CAAwC;AAExC,MAAM,eAAe,GAAG,CAAC,gBAAgB,CAAC,CAAC;AAE9B,QAAA,OAAO,GAAG,KAAK,CAAC;AAChB,QAAA,QAAQ,GAAG,4BAA4B,CAAC;AAE9C,MAAM,OAAO,GAAG,CAAC,IAAgB,EAAE,EAAE;IAC1C,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE;QACvB,QAAQ,EAAE,2BAA2B;QACrC,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,KAAK,EAAE,IAAI;KACZ,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;QAClB,QAAQ,EACN,wIAAwI;QAC1I,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;KACX,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE;QAC5B,QAAQ,EAAE,uBAAuB;QACjC,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;KAC7B,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE;QACvB,QAAQ,EAAE,4BAA4B;QACtC,OAAO,EAAE,IAAI;QACb,OAAO,EAAE,KAAK;KACf,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE;QACvB,QAAQ,EACN,kGAAkG;QACpG,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,IAAI;KACZ,CAAC,CAAC;IAEH,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;QACxB,QAAQ,EAAE,mHAAmH;QAC7H,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,cAAM,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;KACnE,CAAC,CAAC;IAEH,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;AACvB,CAAC,CAAC;AApCW,QAAA,OAAO,WAoClB;AAEK,MAAM,OAAO,GAAG,KAAK,EAAE,IAAI,EAAE,EAAE;IACpC,IAAA,eAAO,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAEtB,IAAI,WAAW,GAAa,EAAE,CAAC;IAC/B,IAAI,IAAI,CAAC,SAAS,EAAE;QAClB,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC;YAC3B,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC;YACrC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;KACtC;IAED,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;IAChC,IAAI,SAAS,GAAyB,IAAI,CAAC,QAAQ,CAAC;IACpD,IAAI,SAAS,EAAE;QACb,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;KAChE;IACD,IAAI,YAAY,GAAuB,IAAI,CAAC,WAAW,CAAC;IACxD,IAAI,SAA6B,CAAC;IAClC,IAAI,YAAY;QAAE,SAAS,GAAG,YAAsB,CAAC;IAErD,MAAM,aAAa,GAAG,GAAG,EAAE;QACzB,IAAI,IAAI,CAAC,aAAa,KAAK,OAAO,EAAE;YAClC,IAAA,aAAG,EAAC,0EAA0E,CAAC,CAAC;YAChF,OAAO,IAAI,CAAC;SACb;QAED,IAAI,IAAI,CAAC,aAAa,KAAK,QAAQ,EAAE;YACnC,IAAA,aAAG,EAAC,4EAA4E,CAAC,CAAC;YAClF,OAAO,KAAK,CAAC;SACd;QAED,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;QACvF,IAAI,QAAQ,EAAE;YACZ,IAAA,aAAG,EAAC,sEAAsE,QAAQ,EAAE,CAAC,CAAC;YACtF,OAAO,IAAI,CAAC;SACb;QAED,IAAA,aAAG,EACD,qDAAqD,eAAe,CAAC,IAAI,CACvE,GAAG,CACJ,8CAA8C,CAChD,CAAC;QACF,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,MAAM,cAAc,GAAG,CAAC,KAA+B,EAAE,EAAE;QACzD,IAAI,SAAS,EAAE;YACb,KAAK,MAAM,MAAM,IAAI,SAAS,EAAE;gBAC9B,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACvC,IAAI,GAAG,IAAI,KAAK,EAAE;oBAChB,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;iBAC7B;aACF;SACF;QACD,IAAI,SAAS,EAAE;YACb,KAAK,CAAC,SAAS,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;SAC3C;IACH,CAAC,CAAC;IAEF,MAAM,eAAe,GAAG,CACtB,QAA4B,EAC5B,eAAwC,EACxC,mBAAoD,EACpD,YAA+B,EAC/B,EAAE;QACF,MAAM,KAAK,GAAG,IAAI,qBAAU,CAAC,QAAQ,EAAE,eAAe,EAAE,mBAAmB,EAAE,YAAY,CAAC,CAAC;QAC3F,cAAc,CAAC,KAAK,CAAC,CAAC;QAEtB,IAAI,KAAyB,CAAC;QAC9B,MAAM,QAAQ,GAAG,CAAC,KAAuB,EAAE,EAAE;YAC3C,IAAI,CAAC,QAAQ;gBAAE,OAAO;YAEtB,IAAI,CAAC,KAAK;gBAAE,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAE/B,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;YACnC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,eAAK,CAAC,IAAI,CAAC,GAAG,OAAO,KAAK,CAAC,CAAC,CAAC;YAClD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,eAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;YAChD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACzC,CAAC,CAAC;QAEF,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAC5B,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,MAAM,gBAAgB,GAAG,CACvB,QAA4B,EAC5B,eAAwC,EACxC,mBAAoD,EACpD,YAA+B,EAC/B,EAAE;QACF,IAAA,0BAAiB,EAAC,KAAK,CAAC,CAAC;QACzB,MAAM,KAAK,GAAG,IAAI,sBAAW,CAAC,QAAQ,EAAE,eAAe,EAAE,mBAAmB,EAAE,YAAY,CAAC,CAAC;QAC5F,cAAc,CAAC,KAAK,CAAC,CAAC;QACtB,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,MAAM,aAAa,GAAG,aAAa,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,gBAAgB,CAAC;IAE3E,IAAA,gDAAuB,EAAC,WAAW,CAAC,CAAC;IAErC,MAAM,UAAU,GAA2B;QACzC,IAAA,eAAM,GAAE;QACR,IAAA,qBAAa,GAAE;QACf,IAAA,qBAAa,GAAE;QACf,IAAA,gBAAY,GAAE;QACd,IAAA,cAAU,GAAE;QACZ,IAAA,kBAAQ,GAAE;QACV,IAAA,yBAAe,GAAE;QACjB,IAAA,wBAAc,EAAC,aAAa,CAAC;QAC7B,IAAA,8BAAoB,GAAE;QACtB,IAAA,kCAAkB,GAAE;QACpB,IAAA,kCAAkB,GAAE;KACrB,CAAC;IACF,MAAM,SAAS,GAAG,IAAI,mBAAS,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAClD,SAAS,CAAC,KAAK,EAAE,CAAC;AACpB,CAAC,CAAC;AAlHW,QAAA,OAAO,WAkHlB"}

package/built/cmds/navie/help.js

@@ -0,0 +1,122 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildHelpIndex = exports.HelpIndex = exports.unpackRef = exports.packRef = exports.DEFAULT_MAX_RESULTS = void 0;
+const lunr_1 = __importDefault(require("lunr"));
+const utils_1 = require("../../utils");
+const console_1 = require("console");
+const promises_1 = require("fs/promises");
+const text_splitter_1 = require("langchain/text_splitter");
+const path_1 = require("path");
+const fs_1 = require("fs");
+const assert_1 = __importDefault(require("assert"));
+const js_yaml_1 = require("js-yaml");
+const DOCS_DIR = ['../../docs', '../../../built/docs']
+    .map((dir) => (0, path_1.join)(__dirname, dir))
+    .find((dir) => (0, fs_1.existsSync)(dir));
+exports.DEFAULT_MAX_RESULTS = 10;
+function packRef(filePath, from, to) {
+    return [filePath, from, to].join(':');
+}
+exports.packRef = packRef;
+function unpackRef(ref) {
+    const [filePath, from, to] = ref.split(':');
+    return [filePath, parseInt(from), parseInt(to)];
+}
+exports.unpackRef = unpackRef;
+class HelpIndex {
+    constructor(idx, _frontMatterByFile, contentByRef) {
+        this.idx = idx;
+        this._frontMatterByFile = _frontMatterByFile;
+        this.contentByRef = contentByRef;
+    }
+    async search(keywords, maxResults = exports.DEFAULT_MAX_RESULTS) {
+        return this.idx
+            .search(keywords.join(' '))
+            .map((result) => {
+            const content = this.contentByRef.get(result.ref);
+            const [filePath, from, to] = unpackRef(result.ref);
+            if (!content) {
+                (0, console_1.warn)(`Could not find content for ${result.ref}`);
+                return;
+            }
+            return {
+                filePath,
+                from,
+                to,
+                content,
+                score: result.score,
+            };
+        })
+            .filter(Boolean).slice(0, maxResults);
+    }
+    static async buildIndex(directory) {
+        const documents = new Array();
+        if ((0, utils_1.verbose)())
+            (0, console_1.log)(`[HelpIndex] Adding help documents to full-text index`);
+        const startTime = Date.now();
+        const frontMatterByFile = new Map();
+        const contentByRef = new Map();
+        const buildDocument = async (filePath) => {
+            const document = await (0, promises_1.readFile)(filePath, 'utf8');
+            let [_, frontMatterStr, text] = document.split('---');
+            if (!frontMatterStr) {
+                frontMatterStr = '';
+                text = document;
+            }
+            let frontMatter;
+            if (frontMatterStr) {
+                try {
+                    frontMatter = (0, js_yaml_1.load)(frontMatterStr);
+                }
+                catch (e) {
+                    (0, console_1.warn)(`Could not parse front matter in ${filePath}`);
+                    (0, console_1.warn)(e);
+                }
+                if (frontMatter)
+                    frontMatterByFile.set(filePath, frontMatter);
+            }
+            const splitter = new text_splitter_1.MarkdownTextSplitter();
+            // TODO: Utilize the front matter
+            const chunks = await splitter.createDocuments([text]);
+            for (let i = 0; i < chunks.length; i++) {
+                const { from, to } = chunks[i].metadata.loc.lines;
+                const id = packRef(filePath, from, to);
+                contentByRef.set(id, chunks[i].pageContent);
+                const pageName = (frontMatter === null || frontMatter === void 0 ? void 0 : frontMatter.name) || (frontMatter === null || frontMatter === void 0 ? void 0 : frontMatter.title);
+                documents.push({ id, pageName, content: chunks[i].pageContent });
+            }
+        };
+        await (0, utils_1.processFiles)(directory, (filePath) => filePath.endsWith('.md'), buildDocument);
+        const idx = (0, lunr_1.default)(function () {
+            this.ref('id');
+            this.field('pageName');
+            this.field('content');
+            this.tokenizer.separator = /[\s/-_:#.]+/;
+            for (const doc of documents)
+                this.add(doc);
+        });
+        const endTime = Date.now();
+        if ((0, utils_1.verbose)())
+            (0, console_1.log)(`[AppMapIndex] Added ${documents.length} AppMaps to full-text index in ${endTime - startTime}ms`);
+        return new HelpIndex(idx, frontMatterByFile, contentByRef);
+    }
+}
+exports.HelpIndex = HelpIndex;
+let helpIndex;
+// TODO: Store the help index JSON in the distribution, so that we don't have to rebuild it when the process loads.
+function buildHelpIndex(directory) {
+    return HelpIndex.buildIndex(directory);
+}
+exports.buildHelpIndex = buildHelpIndex;
+async function collectHelp(helpRequest) {
+    if (!helpIndex) {
+        (0, assert_1.default)(DOCS_DIR, 'Could not find AppMap docs directory');
+        helpIndex = await buildHelpIndex(DOCS_DIR);
+    }
+    return await helpIndex.search(helpRequest.vectorTerms);
+}
+exports.default = collectHelp;
+//# sourceMappingURL=help.js.map

package/built/cmds/navie/help.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"help.js","sourceRoot":"","sources":["../../../src/cmds/navie/help.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AAExB,uCAAuE;AACvE,qCAAoC;AACpC,0CAAuC;AACvC,2DAA+D;AAC/D,+BAA4B;AAC5B,2BAAgC;AAChC,oDAA4B;AAC5B,qCAA+B;AAE/B,MAAM,QAAQ,GAAG,CAAC,YAAY,EAAE,qBAAqB,CAAC;KACnD,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAA,WAAI,EAAC,SAAS,EAAE,GAAG,CAAC,CAAC;KAClC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAA,eAAU,EAAC,GAAG,CAAC,CAAC,CAAC;AAErB,QAAA,mBAAmB,GAAG,EAAE,CAAC;AAEtC,SAAgB,OAAO,CAAC,QAAgB,EAAE,IAAY,EAAE,EAAU;IAChE,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACxC,CAAC;AAFD,0BAEC;AAED,SAAgB,SAAS,CAAC,GAAW;IACnC,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC5C,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;AAClD,CAAC;AAHD,8BAGC;AAOD,MAAa,SAAS;IACpB,YACU,GAAe,EACf,kBAA4C,EAC5C,YAAiC;QAFjC,QAAG,GAAH,GAAG,CAAY;QACf,uBAAkB,GAAlB,kBAAkB,CAA0B;QAC5C,iBAAY,GAAZ,YAAY,CAAqB;IACxC,CAAC;IAEJ,KAAK,CAAC,MAAM,CAAC,QAAkB,EAAE,UAAU,GAAG,2BAAmB;QAC/D,OACE,IAAI,CAAC,GAAG;aACL,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aAC1B,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YACd,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAClD,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACnD,IAAI,CAAC,OAAO,EAAE;gBACZ,IAAA,cAAI,EAAC,8BAA8B,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC;gBACjD,OAAO;aACR;YACD,OAAO;gBACL,QAAQ;gBACR,IAAI;gBACJ,EAAE;gBACF,OAAO;gBACP,KAAK,EAAE,MAAM,CAAC,KAAK;aACpB,CAAC;QACJ,CAAC,CAAC;aACD,MAAM,CAAC,OAAO,CAClB,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;IACzB,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,SAAiB;QACvC,MAAM,SAAS,GAAG,IAAI,KAAK,EAAO,CAAC;QAEnC,IAAI,IAAA,eAAO,GAAE;YAAE,IAAA,aAAG,EAAC,sDAAsD,CAAC,CAAC;QAC3E,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAE7B,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAuB,CAAC;QACzD,MAAM,YAAY,GAAG,IAAI,GAAG,EAAkB,CAAC;QAC/C,MAAM,aAAa,GAAG,KAAK,EAAE,QAAgB,EAAE,EAAE;YAC/C,MAAM,QAAQ,GAAG,MAAM,IAAA,mBAAQ,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAElD,IAAI,CAAC,CAAC,EAAE,cAAc,EAAE,IAAI,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACtD,IAAI,CAAC,cAAc,EAAE;gBACnB,cAAc,GAAG,EAAE,CAAC;gBACpB,IAAI,GAAG,QAAQ,CAAC;aACjB;YACD,IAAI,WAAoC,CAAC;YACzC,IAAI,cAAc,EAAE;gBAClB,IAAI;oBACF,WAAW,GAAG,IAAA,cAAI,EAAC,cAAc,CAAgB,CAAC;iBACnD;gBAAC,OAAO,CAAC,EAAE;oBACV,IAAA,cAAI,EAAC,mCAAmC,QAAQ,EAAE,CAAC,CAAC;oBACpD,IAAA,cAAI,EAAC,CAAC,CAAC,CAAC;iBACT;gBACD,IAAI,WAAW;oBAAE,iBAAiB,CAAC,GAAG,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;aAC/D;YAED,MAAM,QAAQ,GAAG,IAAI,oCAAoB,EAAE,CAAC;YAC5C,iCAAiC;YACjC,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;YACtD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBACtC,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC;gBAClD,MAAM,EAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;gBACvC,YAAY,CAAC,GAAG,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;gBAC5C,MAAM,QAAQ,GAAG,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI,MAAI,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,KAAK,CAAA,CAAC;gBACzD,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;aAClE;QACH,CAAC,CAAC;QAEF,MAAM,IAAA,oBAAY,EAAC,SAAS,EAAE,CAAC,QAAgB,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC,CAAC;QAE7F,MAAM,GAAG,GAAG,IAAA,cAAI,EAAC;YACf,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACf,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YACvB,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YAEtB,IAAI,CAAC,SAAS,CAAC,SAAS,GAAG,aAAa,CAAC;YAEzC,KAAK,MAAM,GAAG,IAAI,SAAS;gBAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC3B,IAAI,IAAA,eAAO,GAAE;YACX,IAAA,aAAG,EACD,uBAAuB,SAAS,CAAC,MAAM,kCACrC,OAAO,GAAG,SACZ,IAAI,CACL,CAAC;QACJ,OAAO,IAAI,SAAS,CAAC,GAAG,EAAE,iBAAiB,EAAE,YAAY,CAAC,CAAC;IAC7D,CAAC;CACF;AA1FD,8BA0FC;AAED,IAAI,SAAgC,CAAC;AAErC,mHAAmH;AACnH,SAAgB,cAAc,CAAC,SAAiB;IAC9C,OAAO,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;AACzC,CAAC;AAFD,wCAEC;AAEc,KAAK,UAAU,WAAW,CACvC,WAA6B;IAE7B,IAAI,CAAC,SAAS,EAAE;QACd,IAAA,gBAAM,EAAC,QAAQ,EAAE,sCAAsC,CAAC,CAAC;QACzD,SAAS,GAAG,MAAM,cAAc,CAAC,QAAQ,CAAC,CAAC;KAC5C;IAED,OAAO,MAAM,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;AACzD,CAAC;AATD,8BASC"}

package/built/docs/analysis/rules-reference.html

@@ -0,0 +1,27 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title>AppMap | {{ page.title }}</title>
+  </head>
+  <!-- Layout: default -->
+  <body>
+    <script>
+(function () {
+    // https://stackoverflow.com/a/21198129
+    var hash = window.location.hash.substring(1);
+    let newLocation = '/docs/reference/analysis-rules';
+    if (hash) {
+        newLocation += '#' + hash;
+    }
+    window.location = newLocation;
+})();
+    </script>
+    <p>
+      You're being redirected to the new home of this content:
+    </p>
+    <p>
+      <a href="https://docs.appland.com/docs/reference/analysis-rules.html">https://docs.appland.com/docs/reference/analysis-rules.html</a>
+    </p>
+  </body>
+</html>

package/built/docs/appmap-overview.md

@@ -0,0 +1,54 @@
+---
+layout: docs
+toc: true
+title: Docs - AppMap overview
+redirect_from: [/docs, /docs/faq]
+
+---
+# AppMap overview
+
+AppMap is an open-source runtime code analysis tool.
+
+AppMap records code execution traces, collecting information about how your code works and what it does. Then it presents this information as interactive diagrams that you can search and navigate. In the diagrams, you can see exactly how functions, web services, data stores, security, I/O, and dependent services all work together when application code runs.
+
+You use AppMaps right in your code editor, using an AppMap extension or plugin. AppMaps also link directly to code, so you can use the information in the diagrams to make immediate code changes and improvements.
+
+Over 85,000 software developers are using the [AppMap extension for VSCode](https://marketplace.visualstudio.com/items?itemName=appland.appmap) and the [AppMap plugin for JetBrains](https://plugins.jetbrains.com/plugin/16701-appmap).
+
+<a class="btn btn-primary btn-lg" href="https://getappmap.com/">Get Started with AppMap</a>
+
+![Getting started screenshot](/assets/img/docs/dependency-map-example.webp)
+_AppMap dependency map in Visual Studio Code_
+
+## What kind of code does it work with?
+
+AppMap works best with web application and API frameworks, such as Rails, Django, Flask, Express, and Spring. That's because AppMap has specialized features for mapping web services, routing, view templates, HTTP client requests, caching, authentication, and SQL. You can map any kind of project that's written in a supported language, but it's when you map a database-backed web application or API service that you'll see the full power of AppMap.
+
+AppMap works equally well with small and large projects - monoliths and microservices. And by large, we mean large. AppMap has been used successfully on code bases with 10 million lines of code. For a project that large, AppMap is a truly game-changing way to understand what the code is doing, from the front-end templates and web services, through the classes and functions, through SQL and HTTP client requests, and back.
+
+{% include docs/app_framework_logos.html %}
+
+## What can I use it for?
+
+**Help new developers get oriented by creating a library of key AppMaps**
+
+If you're an expert on a code base, you can create AppMaps that will help other developers to learn how the code works, ramp up quickly, and contribute. Start collecting AppMaps of key flows into a project Wiki or README. Then, when you get questions about the code base, you can direct developers there to get "self-service" code onboarding help from AppMaps.
+
+**Use AppMaps to add context to bug reports and other code issues**
+
+If you find a bug or security flaw, you can record an AppMap and attach it to the code issue/ticket. The AppMap will be a massive help to the developer who takes on the task of finding and fixing the bug. Developers, security testers, and QA people can all help make bug fixing easier by recording and submitting AppMaps to the dev team.
+
+
+**Use AppMaps to learn new-to-you code**
+
+If you're new to a code base, you can ask a code expert to provide you with some AppMaps that will orient you to the work you've been asked to do. The code expert can direct you to a Wiki or README that has AppMaps of key flows. Or, the code expert can make you a custom AppMap - and then you can return the favor by contributing the AppMap to the project Wiki or README, along with some of your own thoughts about how to use it.
+
+## Features
+
+* **Code execution recording** AppMap agent libraries record executing code and save the data as JSON files. Running test cases is the most common way to record AppMaps, but it’s not the only way. You can find additional examples of how to record AppMaps in the [Recording AppMaps](/docs/recording-methods.html) documentation.
+* **Interactive diagrams** Sequence Diagrams, Flame Graphs, and Dependency maps are created automatically, showing how the modules and packages in your code relate to each other for a specific AppMap. A Trace diagram shows the code execution tree, including web services, functions, SQL queries, parameter values, status codes, etc. Learn more about [AppMap Diagrams](/docs/diagrams).
+* **SQL query data** AppMap records all SQL queries that your application makes. Whether a query is listed explicitly in the code, or automatically generated by an object-relational mapping (ORM) library, you can see exactly what’s happening between your code and the database. Learn more about [How to use SQL in AppMaps](/docs/diagrams/how-to-use-appmaps.html#how-to-read-sql-code-in-appmaps) 
+* **Web services data** AppMap records all HTTP server requests that are handled by your application. The AppMap includes the request method, path, headers, parameters, and status code, so you can see exactly what message your application received, and how it responded. AppMap captures so much information about HTTP server requests that it can automatically generate a complete OpenAPI (aka Swagger) file for your application. Learn more about [generating the OpenAPI description file](/docs/openapi).
+* **Code labels** You can apply labels to the most important functions in your code. You can quickly identify and locate the most important functions in each code path by searching for labels in AppMap Diagrams. Labels are maintained right in the code base using annotations (Java and Python) or code comments (Ruby). Because labels are in the code, all developers can collaborate on labeling, and the code is always the source of truth for labels.
+* **Open source** AppMap agent libraries and UI code are all available as MIT License open source. Learn about [Open Source contributions and our community](/docs/community.html).
+

package/built/docs/community.md

@@ -0,0 +1,27 @@
+---
+layout: docs
+toc: true
+title: Docs - Community
+redirect_from: [/docs/troubleshooting]
+---
+# Community
+
+## Forum
+[AppMap Slack](https://appmap.io/slack) is the best place for discussing AppMap with team members and community users.  Ask questions about installation and setup of AppMap agents, get expert advice about the recording strategies for your applications, and share your AppMaps with people who code in your language.  
+
+## Reporting problems
+[Join us on Slack](https://appmap.io/slack) and share your findings with us, or visit the [GitHub repositories](https://github.com/getappmap) and submit tickets there.
+
+## Open source
+AppMap is an open source platform, a suite of projects shared and built with our valued community. We would like to encourage you to join our talented team of contributors and help us build a rapidly growing set of tools that are transforming the way developers and teams are building and maintaining their applications.
+
+### Become a contributor
+- [Join us on Slack](https://appmap.io/slack) and discuss the best assignment to start with
+- You can browse the list of issues in each repo and look for tickets tagged with [“good first issue”](https://github.com/getappmap/vscode-appland/labels/good%20first%20issue)
+- Accept the [CLA](/docs/CLA%20Instructions.pdf)
+- Review and observe our [Code of Conduct](/docs/Code%20of%20Conduct%20for%20Contributors.pdf)
+- Develop and have fun with us
+
+### Projects
+- [AppMap framework](https://github.com/getappmap/appmap)
+- [AppMap client agents and code editor plugins](https://github.com/getappmap)

package/built/docs/diagrams/dependency-map.md

@@ -0,0 +1,63 @@
+---
+layout: docs
+title: Docs - AppMap Diagrams - Dependency Map
+diagrams: true
+name: Dependency Map
+step: 2
+---
+
+# Dependency Map
+The Dependency Map diagram shows all the code that's relevant to what you're working on and how it's connected. Here you can search and navigate through web services, code, libraries, dependency services, and SQL, all in the context of a specific feature.  
+
+The dependency map is fully interactive. You can:
+- [Expand and collapse packages and Web Service endpoints](#expand-and-collapse-packages-and-web-service-endpoints)
+- [View detailed information about dependencies and classes](#view-detailed-information-about-dependencies-and-classes)
+- [List the functions of a class that are used by the executed code](#list-the-functions-of-a-class-that-are-used-by-the-executed-code)
+- [Explore callers and callees](#explore-callers-and-callees)
+- [View SQL queries in dependency map](#view-sql-queries-in-dependency-map)
+- [Open source code right to the line of any particular function.](#open-source-code-right-to-the-line-of-any-particular-function)
+
+![Dependency map overview](/assets/img/docs/dependency-map-overview.webp "Dependency map overview")
+
+#### Expand and collapse packages and Web Service endpoints:
+<div class="video-container">
+  <video playsinline loop autoplay muted>
+    <source src="/assets/img/docs/expand-and-collapse-packages.mp4" type="video/mp4">
+  </video>
+</div>
+
+#### View detailed information about dependencies and classes:
+<div class="video-container">
+  <video playsinline loop autoplay muted>
+    <source src="/assets/img/docs/view-detailed-information-about-dependencies.mp4" type="video/mp4">
+  </video>
+</div>
+
+#### List the functions of a class that are used by the executed code:
+<div class="video-container">
+  <video playsinline loop autoplay muted>
+    <source src="/assets/img/docs/list-the-functions-of-a-class.mp4" type="video/mp4">
+  </video>
+</div>
+
+
+#### Explore callers and callees:
+<div class="video-container">
+  <video playsinline loop autoplay muted>
+    <source src="/assets/img/docs/dependency-explore-callers-and-callees.mp4" type="video/mp4">
+  </video>
+</div>
+
+#### View SQL queries in dependency map:
+<div class="video-container">
+  <video playsinline loop autoplay muted>
+    <source src="/assets/img/docs/view-sql-queries-in-dependency-map.mp4" type="video/mp4">
+  </video>
+</div>
+
+#### Open source code right to the line of any particular function:
+<div class="video-container">
+  <video playsinline loop autoplay muted>
+    <source src="/assets/img/docs/open-source-from-dependency-map.mp4" type="video/mp4">
+  </video>
+</div>

package/built/docs/diagrams/flamegraph.md

@@ -0,0 +1,91 @@
+---
+layout: docs
+title: Docs - Diagrams
+diagrams: true
+name: Flame Graph
+step: 5
+---
+
+# Flame Graph
+
+- [How to read a Flame Graph](#how-to-read-a-flame-graph)
+- [Drilling Down](#drilling-down)
+- [Switching to Other Views](#switching-to-other-views)
+- [Identifying Performance Issues](#identifying-performance-issues)
+  - [Expensive functions and queries](#expensive-functions-and-queries)
+  - [N+1 Queries](#n1-queries)
+  - [Delays from external service calls](#delays-from-external-service-calls)
+
+Flame Graphs visualize the performance of your application’s code. A Flame Graph shows the time spent in each part of your application’s call stack, where the width of the event is proportional to how long it takes to execute.
+
+Flame Graphs make it easy to see how much time is spent in each function, and which calls are the most expensive.
+
+![flame graph image](/assets/img/docs/flamegraph-5.webp)
+
+## How to read a Flame Graph
+
+The lowest layer in a Flame Graph represents the AppMap, and it contains the map’s name. For AppMaps 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.
+
+![flame graph image](/assets/img/docs/flamegraph-8.webp)
+
+Events in a Flame Graph are ordered bottom-up for functions calling other functions, and left-to-right for subsequent calls. To illustrate, the events in the map below are numbered according to the sequence in which they occurred.
+
+![flame graph image](/assets/img/docs/flamegraph-9.png)
+
+Cells in the flame graph are colored similarly to how they appear in the other AppMap views like the Dependency Map and Sequence Diagram. Blue represents classes, purple represents database queries, and yellow represents outgoing calls to other services. The lowest level of the Flame Graph, the map name, is colored teal.
+
+Each event cell also shows the elapsed time spent executing it. This may be displayed in ms (milliseconds) or µ (microseconds). 
+
+![flame graph image](/assets/img/docs/flamegraph-4.png)
+
+Timing data and event names may not always fit on small cells. These can be revealed by hovering your mouse pointer over the cell.
+
+## Drilling Down
+
+It can be useful to zoom into particular parts of the call stack to examine the performance of certain functions more closely. Clicking on any event will expand it to the full width, allowing you to more clearly see the functions which it called.
+
+<div class="video-container">
+  <video playsinline loop autoplay muted>
+    <source src="/assets/img/docs/flamegraph-6.mp4" type="video/mp4">
+  </video>
+</div>
+
+You can also drill deeper into the Flame Graph using the zoom control on the right by clicking on the `+` and `-` controls, or by dragging the zoom bar. You can also zoom using your mouse wheel, and the graph will zoom towards the position of your mouse pointer.
+
+<div class="video-container">
+  <video playsinline loop autoplay muted>
+    <source src="/assets/img/docs/flamegraph-2.mp4" type="video/mp4">
+  </video>
+</div>
+
+AppMap filter settings also apply to Flame Graphs. For example, if you decide to hide calls to certain types of events (for example, by excluding calls to a logging package) those events will not appear in the Flame Graph. 
+
+## Switching to Other Views
+
+While investigating an event in an application, you can also view the same event in the Sequence Diagram and Trace View diagrams. Click on the event in question, and then select either “Show in Sequence” or “Show in Trace”.
+
+Similarly, you can select an event in a Sequence Diagram or Trace View and click “Show in Flame Graph” to see it displayed in a Flame Graph diagram.
+
+![flame graph image](/assets/img/docs/flamegraph-7.gif)
+
+## Identifying Performance Issues
+
+Certain performance problems can be visually easier to spot with a Flame Graph.
+
+#### Expensive functions and queries
+
+Expensive functions are those that are slow due to them doing a lot of computation and not spending much time waiting on other functions to return. In the example graph shown below, the function at the bottom of the stack is spending most of its 15.1 milliseconds of time waiting for the functions and queries which it called to return. The most expensive area in this stack is therefore the SQL `SELECT` query at the top which takes 10.3 milliseconds. That query should likely be the focus of any performance optimization effort over the other functions and queries.
+
+![flame graph image](/assets/img/docs/flamegraph-expensive.png)
+
+#### N+1 Queries
+
+AppMap Analysis automatically detects [N+1 queries](/docs/reference/analysis-rules#n-plus-one-query), which are identical database queries called by the same parent function. In the example graph below, 60 repeated queries are visible at the top of the call stack.
+
+![flame graph image](/assets/img/docs/flamegraph-1.gif)
+
+#### Delays from external service calls
+
+Performance problems can sometimes be caused by latency in external services. In the example graph below, the event in yellow represents a call to another service using HTTP. The call took 936 milliseconds to return, and only a few milliseconds more for the calling function to deal with that. Any optimization efforts for this area should therefore be spent in that other application, preferably by generating an AppMap for its `/users` API.
+
+![flame graph image](/assets/img/docs/flamegraph-external-svc.png)

package/built/docs/diagrams/how-it-works.md

@@ -0,0 +1,60 @@
+---
+layout: docs
+title: Docs - Diagrams
+diagrams: true
+name: How it works
+step: 1
+redirect_from: [/docs/how-to-use-appmap-diagrams.html, /docs/how-to-use-appmap-diagrams, /docs/diagrams/how-to-use-appmaps]
+---
+
+# How it works
+
+AppMap records the behavior of running code into JSON files, and visualizes them in interactive diagrams right in your code editor.
+
+{% include docs/how_it_works_illo.html %}
+
+## AppMap agent records executing code as JSON files
+Once your app is instrumented, the AppMap agent creates JSON files as you execute test cases, run sample programs, or perform interactive sessions with your app.
+
+AppMap files can be most conveniently recorded from automated tests, but other methods of recording are preferred in certain situations, such as direct recording of code blocks or remote recording controlled with REST endpoints. [Learn more about Recording AppMaps](/docs/recording-methods).
+
+## Quick search for HTTP routes, packages, classes, and functions in the left-hand navigation bar
+
+Use the navigation bar for quick navigation to items of interest, for example, HTTP routes, labels, packages, classes, functions.
+
+<div class="video-container">
+  <video playsinline loop autoplay muted>
+    <source src="/assets/img/docs/navigate-to-interest.mp4" type="video/mp4">
+  </video>
+</div>
+
+## Use the filtering icon to reduce the number of objects in the AppMap view 
+
+Filter out items such as unlabeled code, specific classes or packages, external code, and more. 
+
+<div class="video-container">
+  <video playsinline loop autoplay muted>
+    <source src="/assets/img/docs/filter-appmaps.mp4" type="video/mp4">
+  </video>
+</div>
+
+## Show more detailed statistics about your AppMap 
+
+Includes the frequency of specific function calls and the size represented within the AppMap.  This is helpful when [handling large AppMaps](https://appmap.io/docs/guides/handling-large-appmaps.html) and to reduce their size. 
+
+<img src="/assets/img/docs/appmap-stats.webp"/>
+
+## Expand and Collapse the Depth of Sequence Diagrams
+
+This will hide or show all actions that are deeper in the call stack than the selected value, and will result in a more compact diagram. Actions can be expanded or collapsed with the `+` or `-` controls to change the depth of the calls shown within your sequence diagram.  
+
+<div class="video-container">
+  <video playsinline loop autoplay muted>
+    <source src="/assets/img/docs/sequence-diagram-expand.mp4" type="video/mp4">
+  </video>
+</div>
+
+## Demo of using AppMaps
+This video demonstrates how to use AppMap Diagrams when learning how unfamiliar code works:
+
+<div style="position: relative; padding-bottom: 56.25%; height: 0;"><iframe src="https://www.loom.com/embed/de75ba638d57418da2d42417936cdf95" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>