{"_id":"@cadcrawl/cad-browser","_rev":"3-41f6f6bc32e1021bdf5e22bc2fbfde67","name":"@cadcrawl/cad-browser","dist-tags":{"latest":"0.4.1"},"versions":{"0.3.0":{"name":"@cadcrawl/cad-browser","version":"0.3.0","keywords":["cad","step","stl","3mf","pdf","engineering","file-browser","preview"],"license":"PolyForm-Noncommercial-1.0.0","_id":"@cadcrawl/cad-browser@0.3.0","maintainers":[{"name":"artemikorotkov","email":"art22017@yandex.ru"}],"homepage":"https://github.com/art22017/cadcrawl/tree/master/cad-browser#readme","bugs":{"url":"https://github.com/art22017/cadcrawl/issues"},"bin":{"cad-browser":"bin/cad-browser"},"dist":{"shasum":"a53c7b6ac09adf196e94f7d4be584580e097aa01","tarball":"https://registry.npmjs.org/@cadcrawl/cad-browser/-/cad-browser-0.3.0.tgz","fileCount":19,"integrity":"sha512-YWdGVGl0qV6M8rC05J7NQ1NhUr3qxPBZdUhn376Io7wykOibflwCOycAOlVb0RNr+rdJe8Fdu0kXLMMxOW7Nbw==","signatures":[{"sig":"MEQCIBylHw9bj6UkIPk/ATZt36eZFBTDxN5RnukYAAkIn4RMAiA2y3hFsNzHQIeIMPOtWw59K0FpalWsNWdf0WqXn7rJJw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":307673},"type":"module","engines":{"node":">=20"},"gitHead":"8d5f2a19c0a36b662c1063d9af2d25c4e271cb88","scripts":{"dev":"vite","test":"node --test","build":"vite build","start":"node bin/cad-browser","prepublishOnly":"npm run test && npm run build"},"_npmUser":{"name":"artemikorotkov","email":"art22017@yandex.ru"},"repository":{"url":"git+https://github.com/art22017/cadcrawl.git","type":"git","directory":"cad-browser"},"_npmVersion":"11.10.1","description":"Local engineering file browser with CAD and PDF previews powered by cad-toolbox.","directories":{},"_nodeVersion":"24.15.0","dependencies":{"open":"^10.2.0","express":"^5.1.0","@cadcrawl/cad-toolbox":"^0.3.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"vite":"^6.1.0","react":"^19.0.0","react-dom":"^19.0.0","lucide-react":"^0.468.0","@vitejs/plugin-react":"^4.6.0"},"_npmOperationalInternal":{"tmp":"tmp/cad-browser_0.3.0_1782310913506_0.6320876202514807","host":"s3://npm-registry-packages-npm-production"}},"0.4.0":{"name":"@cadcrawl/cad-browser","version":"0.4.0","keywords":["cad","step","stl","3mf","pdf","engineering","file-browser","preview"],"license":"PolyForm-Noncommercial-1.0.0","_id":"@cadcrawl/cad-browser@0.4.0","maintainers":[{"name":"artemikorotkov","email":"art22017@yandex.ru"}],"homepage":"https://github.com/art22017/cadcrawl/tree/master/cad-browser#readme","bugs":{"url":"https://github.com/art22017/cadcrawl/issues"},"bin":{"cad-browser":"bin/cad-browser"},"dist":{"shasum":"acdf5c72aef57bdf520c284d1bfabba6ab0662e4","tarball":"https://registry.npmjs.org/@cadcrawl/cad-browser/-/cad-browser-0.4.0.tgz","fileCount":19,"integrity":"sha512-w8mo1V045fc7/lf3oyIJ/YrvOPFeEqpdk8WEeIpN586oWZa+xPxKrBuDnGfdm+nrkXwBJPZBq8R2ivNwAAIsuA==","signatures":[{"sig":"MEQCIACL+tegjaYR+JhWhbd0BrkkDMk50dGjsEI1HYGnwcMkAiA8K9PbySE2biq6zhlWVnPJqel5efesRWk1kbbotfvacA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":312494},"type":"module","engines":{"node":">=20"},"gitHead":"47914551051bcb51a4663939f4399fe703f0051f","scripts":{"dev":"vite","test":"node --test","build":"vite build","start":"node bin/cad-browser","prepublishOnly":"npm run test && npm run build"},"_npmUser":{"name":"artemikorotkov","email":"art22017@yandex.ru"},"repository":{"url":"git+https://github.com/art22017/cadcrawl.git","type":"git","directory":"cad-browser"},"_npmVersion":"11.10.1","description":"Local engineering file browser with CAD and PDF previews powered by cad-toolbox.","directories":{},"_nodeVersion":"24.15.0","dependencies":{"open":"^10.2.0","express":"^5.1.0","@cadcrawl/cad-toolbox":"^0.3.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"vite":"^6.1.0","react":"^19.0.0","react-dom":"^19.0.0","lucide-react":"^0.468.0","@vitejs/plugin-react":"^4.6.0"},"_npmOperationalInternal":{"tmp":"tmp/cad-browser_0.4.0_1782311812872_0.731462069993408","host":"s3://npm-registry-packages-npm-production"}},"0.4.1":{"name":"@cadcrawl/cad-browser","version":"0.4.1","description":"Local engineering file browser with CAD and PDF previews powered by cad-toolbox.","type":"module","license":"PolyForm-Noncommercial-1.0.0","homepage":"https://github.com/cadcrawl/cad-browser#readme","repository":{"type":"git","url":"git+https://github.com/cadcrawl/cad-browser.git"},"bugs":{"url":"https://github.com/cadcrawl/cad-browser/issues"},"keywords":["cad","step","stl","3mf","pdf","engineering","file-browser","preview"],"bin":{"cad-browser":"bin/cad-browser"},"publishConfig":{"access":"public"},"scripts":{"build":"vite build","dev":"vite","start":"node bin/cad-browser","test":"node --test","prepublishOnly":"npm run test && npm run build"},"engines":{"node":">=20"},"dependencies":{"@cadcrawl/cad-toolbox":"^0.3.0","express":"^5.1.0","open":"^10.2.0"},"devDependencies":{"@vitejs/plugin-react":"^4.6.0","lucide-react":"^0.468.0","vite":"^6.1.0","react":"^19.0.0","react-dom":"^19.0.0"},"gitHead":"1791acaeac094e0a84984e69c7e0772e0a2d0d0f","_id":"@cadcrawl/cad-browser@0.4.1","_nodeVersion":"24.15.0","_npmVersion":"11.10.1","dist":{"integrity":"sha512-JVbrrD98GHQSiKY0IpIFdNBIO6wAsZTaI3Pq7EASDiBpkkg8wbszkCea2kwN8QLYnWvE20CPOzCdAMRxX4vQMQ==","shasum":"98ed563bc4047ae8a9d81eb24ad5fb3acf3c7564","tarball":"https://registry.npmjs.org/@cadcrawl/cad-browser/-/cad-browser-0.4.1.tgz","fileCount":20,"unpackedSize":316129,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQCkb7kG1q9lsPt1IossluU46Bxq3CFIPWZRv+MMOWPr4QIgWT38Y9Mvp3d5/Wk03WktJ5fRgwIgG+HuYIcclrYM6oU="}]},"_npmUser":{"name":"artemikorotkov","email":"art22017@yandex.ru"},"directories":{},"maintainers":[{"name":"artemikorotkov","email":"art22017@yandex.ru"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/cad-browser_0.4.1_1782411530696_0.9493126361937825"},"_hasShrinkwrap":false}},"time":{"created":"2026-06-24T14:21:53.362Z","modified":"2026-06-25T18:18:51.030Z","0.3.0":"2026-06-24T14:21:53.673Z","0.4.0":"2026-06-24T14:36:53.011Z","0.4.1":"2026-06-25T18:18:50.849Z"},"bugs":{"url":"https://github.com/cadcrawl/cad-browser/issues"},"license":"PolyForm-Noncommercial-1.0.0","homepage":"https://github.com/cadcrawl/cad-browser#readme","keywords":["cad","step","stl","3mf","pdf","engineering","file-browser","preview"],"repository":{"type":"git","url":"git+https://github.com/cadcrawl/cad-browser.git"},"description":"Local engineering file browser with CAD and PDF previews powered by cad-toolbox.","maintainers":[{"name":"artemikorotkov","email":"art22017@yandex.ru"}],"readme":"# CAD Browser\n\nCAD Browser turns any local engineering project folder into a searchable visual file browser.\n\nRun one command inside a project and CAD Browser opens a private local website with a folder tree, thumbnails, previews, engineering metadata, document text, and desktop file actions.\n\nEverything runs on your computer. Project files are not uploaded.\n\n## Quick start\n\nOpen a terminal inside the folder you want to browse:\n\n```powershell\ncd C:\\engineering\\project\nnpx @cadcrawl/cad-browser\n```\n\nCAD Browser starts at:\n\n```text\nhttp://127.0.0.1:6767\n```\n\nYou can also pass a folder explicitly:\n\n```powershell\nnpx @cadcrawl/cad-browser C:\\engineering\\project\n```\n\nUse the latest published version explicitly when needed:\n\n```powershell\nnpx @cadcrawl/cad-browser@latest\n```\n\n## What it provides\n\n- Navigable project folder tree.\n- Grid and list file views.\n- Tile density from 4 to 15 columns.\n- Search across filenames, paths, PDF text, Markdown, and TXT content.\n- Filtering by CAD, PDF, text, image, or other file types.\n- Sorting by name, modification date, size, or type.\n- CAD and drawing thumbnails generated locally.\n- Detailed file inspector.\n- Open files in their default desktop application.\n- Reveal files in Windows Explorer, macOS Finder, or the platform file manager.\n- Copy project-relative paths.\n- Rebuild cached metadata and previews.\n\n## Supported file types\n\n| Type | Support |\n|---|---|\n| STEP / STP | Preview, bounding box, geometry, colors, model tree |\n| STL | Preview, bounding box, geometry, available colors |\n| 3MF | Preview, bounding box, geometry, available materials |\n| PDF | First-page preview, page count, extracted text |\n| Markdown (`.md`) | Content search, text preview, line/word/character counts |\n| Text (`.txt`) | Content search, text preview, line/word/character counts |\n| Images | Native thumbnail and preview |\n| Other files | Folder browsing, metadata, Open and Reveal actions |\n\nText indexing reads up to the first 256 KB of each Markdown or TXT file. The inspector indicates when a document was truncated.\n\n## Folder tree\n\nThe project tree follows standard file-manager behavior:\n\n- Click a folder name to open that folder.\n- Click the arrow beside a folder to expand or collapse its subfolders.\n- Folders without subfolders do not show an expansion arrow.\n- Opening a folder does not automatically change its expanded state.\n\n## File inspector\n\nSelect a file to open the inspector.\n\nDepending on the file type, it can show:\n\n- file size and modification time\n- analysis status\n- bounding-box dimensions and coordinates\n- mesh, vertex, and triangle counts\n- materials and face colors\n- STEP model structure\n- PDF page count and extracted text\n- Markdown and TXT statistics and content\n\nInspector actions:\n\n- **Open** — launch the file in its default application.\n- **Reveal** — select the file in the system file manager.\n- **Copy path** — copy its project-relative path.\n- **Rebuild metadata and preview** — invalidate the current analysis and process the file again.\n\nDouble-clicking a file card also opens the file in its default application.\n\n## Search\n\nSearch covers the entire project, even when a subfolder is currently open.\n\nIt matches:\n\n- filenames\n- relative paths\n- extracted PDF text\n- Markdown content\n- TXT content\n\n## Keyboard shortcuts\n\n| Shortcut | Action |\n|---|---|\n| `Ctrl/Cmd + K` | Focus project search |\n| `/` | Focus project search |\n| `Escape` | Close preview, clear search, or close inspector |\n| Arrow keys | Move through visible files |\n| `Enter` | Open the selected preview |\n| `O` | Open the selected file |\n| `R` | Reveal the selected file |\n\n## Command options\n\n```text\nnpx @cadcrawl/cad-browser [directory] [options]\n```\n\n| Option | Description |\n|---|---|\n| `--port <number>` | Local port. Default: `6767` |\n| `--host <address>` | Bind address. Default: `127.0.0.1` |\n| `--no-open` | Start without opening a browser window |\n| `--help` | Show command help |\n\nExamples:\n\n```powershell\nnpx @cadcrawl/cad-browser . --port 7000\n```\n\n```powershell\nnpx @cadcrawl/cad-browser C:\\engineering\\archive --no-open\n```\n\n## Local cache\n\nCAD Browser keeps generated metadata and previews outside the browsed project:\n\n```text\n~/.cadcrawl/cad-browser/projects/\n```\n\nThe selected project folder is not modified.\n\nCached data is reused while the file size and modification time match. CAD render files also use source-hash validation through [`@cadcrawl/cad-toolbox`](https://www.npmjs.com/package/@cadcrawl/cad-toolbox).\n\nDelete the cache folder at any time if you want CAD Browser to recreate all local data.\n\n## Privacy\n\n- Files remain on the local machine.\n- The web interface is served locally.\n- The default bind address is `127.0.0.1`.\n- No CAD files or document contents are uploaded by CAD Browser.\n\n## Requirements\n\n- Node.js 20 or newer.\n- A supported desktop browser.\n- Windows is the primary platform; macOS and Linux file actions are also supported.\n\n## Troubleshooting\n\n### The port is already in use\n\nChoose another port:\n\n```powershell\nnpx @cadcrawl/cad-browser . --port 7000\n```\n\n### A preview is stale\n\nSelect the file and use **Rebuild metadata and preview** in the inspector.\n\n### `npx` uses an older cached version\n\nRun the latest version explicitly:\n\n```powershell\nnpx @cadcrawl/cad-browser@latest\n```\n\n### Explorer or the default application does not open\n\nConfirm that the file still exists and that its extension has a default desktop application configured.\n\n## License\n\n[PolyForm Noncommercial License 1.0.0](LICENSE.md)\n","readmeFilename":"README.md"}