1"use strict";(self.webpackChunkjs_recon_docs=self.webpackChunkjs_recon_docs||[]).push([[8026],{28453:(e,r,n)=>{n.d(r,{R:()=>o,x:()=>l});var d=n(96540);const s={},t=d.createContext(s);function o(e){const r=d.useContext(t);return d.useMemo(function(){return"function"==typeof e?e(r):{...r,...e}},[r,e])}function l(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),d.createElement(t.Provider,{value:r},e.children)}},35676:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>i,contentTitle:()=>l,default:()=>h,frontMatter:()=>o,metadata:()=>d,toc:()=>c});const d=JSON.parse('{"id":"docs/modules/report","title":"Report command","description":"The report command generates a report based on the results of the analyze module.","source":"@site/versioned_docs/version-1.2.2/docs/modules/report.md","sourceDirName":"docs/modules","slug":"/docs/modules/report","permalink":"/docs/1.2.2/docs/modules/report","draft":false,"unlisted":false,"editUrl":"https://github.com/js-recon/js-recon-docs/edit/main/versioned_docs/version-1.2.2/docs/modules/report.md","tags":[],"version":"1.2.2","sidebarPosition":10,"frontMatter":{"sidebar_position":10},"sidebar":"docsSidebar","previous":{"title":"Analyze command","permalink":"/docs/1.2.2/docs/modules/analyze"},"next":{"title":"Rules","permalink":"/docs/1.2.2/category/rules"}}');var s=n(74848),t=n(28453);const o={sidebar_position:10},l="Report command",i={},c=[{value:"Usage",id:"usage",level:2},{value:"Options",id:"options",level:2},{value:"Example",id:"example",level:2},{value:"Generate report for mapped JSON file",id:"generate-report-for-mapped-json-file",level:3},{value:"Generate report for analyze JSON file",id:"generate-report-for-analyze-json-file",level:3},{value:"Generate report for every file",id:"generate-report-for-every-file",level:3}];function a(e){const r={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.header,{children:(0,s.jsx)(r.h1,{id:"report-command",children:"Report command"})}),"\n",(0,s.jsxs)(r.p,{children:["The ",(0,s.jsx)(r.code,{children:"report"})," command generates a report based on the results of the analyze module."]}),"\n",(0,s.jsx)(r.h2,{id:"usage",children:"Usage"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-bash",children:"js-recon report [options]\n"})}),"\n",(0,s.jsx)(r.h2,{id:"options",children:"Options"}),"\n",(0,s.jsxs)(r.table,{children:[(0,s.jsx)(r.thead,{children:(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.th,{children:"Option"}),(0,s.jsx)(r.th,{children:"Alias"}),(0,s.jsx)(r.th,{children:"Description"}),(0,s.jsx)(r.th,{children:"Default"}),(0,s.jsx)(r.th,{children:"Required"})]})}),(0,s.jsxs)(r.tbody,{children:[(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"--sqlite-db <file>"})}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"-s"})}),(0,s.jsx)(r.td,{children:"SQLite database file"}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"js-recon.db"})}),(0,s.jsx)(r.td,{children:"No"})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"--mapped-json <file>"})}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"-m"})}),(0,s.jsx)(r.td,{children:"Mapped JSON file"}),(0,s.jsx)(r.td,{}),(0,s.jsx)(r.td,{children:"No"})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"--analyze-json <file>"})}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"-a"})}),(0,s.jsx)(r.td,{children:"Analyze JSON file"}),(0,s.jsx)(r.td,{}),(0,s.jsx)(r.td,{children:"No"})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"--endpoints-json <file>"})}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"-e"})}),(0,s.jsx)(r.td,{children:"Endpoints JSON file"}),(0,s.jsx)(r.td,{}),(0,s.jsx)(r.td,{children:"No"})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"--map-openapi, --mapped-openapi-json <file>"})}),(0,s.jsx)(r.td,{}),(0,s.jsx)(r.td,{children:"Mapped OpenAPI JSON file"}),(0,s.jsx)(r.td,{}),(0,s.jsx)(r.td,{children:"No"})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"--output <file>"})}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"-o"})}),(0,s.jsx)(r.td,{children:"Output file name (without the extension)"}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"report"})}),(0,s.jsx)(r.td,{children:"No"})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"-h, --help"})}),(0,s.jsx)(r.td,{}
1),(0,s.jsx)(r.td,{children:"display help for command"}),(0,s.jsx)(r.td,{}),(0,s.jsx)(r.td,{children:"No"})]})]})]}),"\n",(0,s.jsx)(r.h2,{id:"example",children:"Example"}),"\n",(0,s.jsx)(r.h3,{id:"generate-report-for-mapped-json-file",children:"Generate report for mapped JSON file"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-bash",children:"js-recon report -m ./mapped.json\n"})}),"\n",(0,s.jsx)(r.h3,{id:"generate-report-for-analyze-json-file",children:"Generate report for analyze JSON file"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-bash",children:"js-recon report -a ./analyze.json\n"})}),"\n",(0,s.jsx)(r.h3,{id:"generate-report-for-every-file",children:"Generate report for every file"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-bash",children:"js-recon report -m mapped.json -a analyze.json -e endpoints.json --map-openapi mapped-openapi.json\n"})})]})}function h(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.