{"_id":"@amazon1148/memorybank-status","name":"@amazon1148/memorybank-status","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.1":{"name":"@amazon1148/memorybank-status","version":"1.0.1","type":"module","description":"A command-line tool for parsing and displaying memory bank status from markdown files, with support for Roo Code's Memory Bank","main":"dist/memorybank-status.js","bin":{"memorybank":"bin/cli.js"},"scripts":{"prebuild":"npm run clean","build":"npm run check-types && npm run lint && npm run docs && tsc && chmod +x dist/memorybank-status.js bin/cli.js","clean":"rimraf dist docs coverage .nyc_output *.tsbuildinfo .tscache","start":"NODE_NO_WARNINGS=1 ./bin/cli.js","check-types":"tsc --noEmit","lint":"eslint . --ignore-pattern '**/*.test.ts' && npm run lint:md && npm run lint:docs","lint:md":"prettier --check README.md","lint:docs":"typedoc --validation","lint:fix":"prettier --write . && eslint . --fix","docs":"typedoc --out docs","docs:watch":"typedoc --out docs --watch","test":"vitest run","test:watch":"vitest","test:coverage":"vitest run --coverage","prepare":"husky","prepublishOnly":"npm run test && npm run build"},"keywords":["memorybank","markdown","cli","roo-code","memory-bank"],"author":{"name":"amazon1148"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/amazon1148/memorybank-status.git"},"bugs":{"url":"https://github.com/amazon1148/memorybank-status/issues"},"homepage":"https://github.com/amazon1148/memorybank-status#readme","devDependencies":{"@types/node":"20.x","@typescript-eslint/eslint-plugin":"^6.21.0","@typescript-eslint/parser":"^6.21.0","@vitest/coverage-v8":"^1.2.2","eslint":"^8.56.0","husky":"^9.0.7","lint-staged":"^15.2.0","prettier":"^3.2.5","rimraf":"^5.0.5","typedoc":"^0.25.7","typescript":"^5.3.3","vitest":"^1.2.2"},"lint-staged":{"*.{js,jsx,ts,tsx,json,css,md}":["prettier --write"],"src/**/*.{ts,tsx}":["prettier --write","eslint --fix"]},"publishConfig":{"access":"public"},"dependencies":{"@types/debug":"^4.1.12","debug":"^4.4.0"},"_id":"@amazon1148/memorybank-status@1.0.1","gitHead":"e92849b029814bac92c7ec3235c36274dad7a4ba","types":"./dist/memorybank-status.d.ts","_nodeVersion":"18.20.5","_npmVersion":"10.9.2","dist":{"integrity":"sha512-ihwtfIqBEQ6ERwPty3iDDABE+2R+TuC/fpc4jkEcSrq/qMALqnGu2TGHTFwLY9GdcAwTL/w6z9nRnw917X9zTQ==","shasum":"17a31c352ec983d039017ab512f37cf589467815","tarball":"https://registry.npmjs.org/@amazon1148/memorybank-status/-/memorybank-status-1.0.1.tgz","fileCount":27,"unpackedSize":80434,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIG6MkdgIT7/6Mz9Y0wmwt3MySuTU/+5tyi2ZQjODLbiZAiB5A9LH9KIFwNAft7mPD+MQr5yYEdY/y38Bcp9NVpNuwg=="}]},"_npmUser":{"name":"amazon1148","email":"setts.kudzus.2y@icloud.com"},"directories":{},"maintainers":[{"name":"amazon1148","email":"setts.kudzus.2y@icloud.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/memorybank-status_1.0.1_1738297281640_0.2567524050088619"},"_hasShrinkwrap":false}},"time":{"created":"2025-01-31T04:21:21.556Z","1.0.1":"2025-01-31T04:21:21.869Z","modified":"2025-01-31T04:21:22.136Z"},"maintainers":[{"name":"amazon1148","email":"setts.kudzus.2y@icloud.com"}],"description":"A command-line tool for parsing and displaying memory bank status from markdown files, with support for Roo Code's Memory Bank","homepage":"https://github.com/amazon1148/memorybank-status#readme","keywords":["memorybank","markdown","cli","roo-code","memory-bank"],"repository":{"type":"git","url":"git+https://github.com/amazon1148/memorybank-status.git"},"author":{"name":"amazon1148"},"bugs":{"url":"https://github.com/amazon1148/memorybank-status/issues"},"license":"MIT","readme":"# Memory Bank CLI\n\nA command-line tool for parsing and displaying checklist status from markdown files. Designed to work with Roo Code's Memory Bank ([GitHub](https://github.com/RooVetGit/Roo-Code/blob/main/prompting/custom%20instructions%20library/roo-code-memory-bank.md) | [Documentation](https://docs.roo.vet/improving-your-prompting-skills/custom-instructions-library/roo-code-memory-bank)), a system that helps maintain perfect documentation across memory resets.\n\n## Project Architecture\n\nThis is a TypeScript ES Module Node.js project:\n\n- Uses native ES modules (package.json `\"type\": \"module\"`)\n- TypeScript configured for ESM output\n- Node.js native ESM imports (e.g., `node:fs`)\n- See package.docs.jsonc for detailed configuration comments\n\n## Features\n\n- Parse markdown files with checklist items\n- Display status with emoji indicators (✅ ⚠️ ❌)\n- Filter incomplete items with `--incomplete` flag\n- Native support for Roo Code's Memory Bank files:\n    - productContext.md\n    - activeContext.md\n    - systemPatterns.md\n    - techContext.md\n    - progress.md\n\n## Installation\n\n### Global Installation (Recommended)\n\n```bash\n# Install globally with npm\nnpm install -g @amazon1148/checklist-status\n\n# Use from anywhere\nchecklist-status path/to/checklist.md\n```\n\n### Local Development\n\n```bash\n# Clone the repository\ngit clone <repository-url>\ncd checklist-status\n\n# Install dependencies\nnpm install\n\n# Build the project\nnpm run build\n```\n\n## Usage\n\n### Single File Mode\n\n```bash\n# Using global installation\nchecklist-status path/to/checklist.md\nchecklist-status path/to/checklist.md --incomplete\n\n# Using local installation\nnode dist/checklist-status.js path/to/checklist.md\nnode dist/checklist-status.js path/to/checklist.md --incomplete\n```\n\n### Memory Bank Mode\n\n```bash\n# Using global installation\nchecklist-status --docs-path=/path/to/roo_code_docs\nchecklist-status --docs-path=/path/to/roo_code_docs --incomplete\n\n# Using local installation\nnode dist/checklist-status.js --docs-path=/path/to/roo_code_docs\nnode dist/checklist-status.js --docs-path=/path/to/roo_code_docs --incomplete\n```\n\n## Configuration\n\n### Logging Options\n\nThe tool provides several logging options to control output verbosity and format:\n\n```bash\n# Default output (INFO level)\nchecklist-status path/to/checklist.md\n\n# Verbose output with debug information\nchecklist-status path/to/checklist.md --verbose\n\n# Quiet mode (errors only)\nchecklist-status path/to/checklist.md --quiet\n\n# JSON output format (for machine parsing)\nchecklist-status path/to/checklist.md --json\n```\n\nLog levels:\n\n- ERROR: Critical errors that prevent the tool from working\n- WARN: Non-fatal issues or concerning conditions\n- INFO: Standard operational information (default)\n- DEBUG: Detailed information for troubleshooting\n\nThe JSON output format includes:\n\n- Timestamp for each log entry\n- Log level\n- Message content\n- Additional context metadata\n- Error details and stack traces when applicable\n\nThese options can be combined with other flags:\n\n```bash\n# Verbose output with incomplete items only\nchecklist-status path/to/checklist.md --verbose --incomplete\n\n# JSON output for Memory Bank mode\nchecklist-status --docs-path=/path/to/docs --json\n```\n\n### Documentation Directory\n\nThe tool supports both local and remote documentation directories. You can specify the location of your Memory Bank documents using the `--docs-path` argument:\n\n```bash\n# Local docs directory\nchecklist-status --docs-path=./docs\n\n# Remote docs directory (absolute path)\nchecklist-status --docs-path=/Users/username/workspace/project/roo_code_docs\n\n# Remote docs directory (with home directory expansion)\nchecklist-status --docs-path=~/workspace/project/roo_code_docs\n```\n\nThe specified directory must contain the following Memory Bank files:\n\n- productContext.md\n- activeContext.md\n- systemPatterns.md\n- techContext.md\n- progress.md\n\n### Git Integration\n\nThe tool uses Git to validate repositories and fetch remote information. By default, it looks for Git in the following locations:\n\n- Windows: `C:\\Program Files\\Git\\bin\\git.cmd`\n- macOS/Linux: `/usr/bin/git`\n\nIf your Git executable is in a different location, you can modify the `GIT_PATHS` constant in `memorybank-status.ts`:\n\n```typescript\nconst GIT_PATHS = {\n\tWINDOWS: \"C:\\\\Program Files\\\\Git\\\\bin\\\\git.cmd\", // Modify for Windows\n\tUNIX: \"/usr/bin/git\", // Modify for macOS/Linux\n} as const\n```\n\n### Environment-Specific Configuration\n\nFor development and testing:\n\n1. Update test paths in `tests/memorybank-status.test.ts`:\n\n    ```typescript\n    const TEST_PATHS = {\n    \tHOME: \"/Users/test\", // Update for your environment\n    \tWORKSPACE: \"/Users/test/workspace\",\n    \tSYSTEM_LOG: \"/var/log\",\n    \tGIT: {\n    \t\tMACOS: \"/usr/bin/git\",\n    \t\tWINDOWS: \"C:\\\\Program Files\\\\Git\\\\bin\\\\git.cmd\",\n    \t\tLINUX: \"/usr/bin/git\",\n    \t},\n    } as const\n    ```\n\n2. When running tests, ensure the paths match your development environment.\n\n## Checklist Format\n\nThe tool expects markdown files with the following format:\n\n```markdown\n## Section Name\n\n### Subsection Name\n\n- ✅ Completed item\n- ⚠️ Partially implemented item\n- ❌ Not implemented item\n- Regular item (defaults to pending)\n```\n\nThis format is compatible with Roo Code's Memory Bank documentation structure, making it easy to track progress across different aspects of your project.\n\n## Development\n\n```bash\n# Run tests\nnpm test\n\n# Run linting\nnpm run lint\n\n# Run linting with auto-fix\nnpm run lint:fix\n```\n\n## Related Documentation\n\n- [Roo Code's Memory Bank Documentation](https://docs.roo.vet/improving-your-prompting-skills/custom-instructions-library/roo-code-memory-bank) - Official documentation\n- [Roo Code's Memory Bank GitHub](https://github.com/RooVetGit/Roo-Code/blob/main/prompting/custom%20instructions%20library/roo-code-memory-bank.md) - Source repository\n\n## License\n\nMIT\n","readmeFilename":"README.md"}