{"id":13525006,"url":"https://github.com/bahmutov/manpm","last_synced_at":"2025-09-28T20:30:51.415Z","repository":{"id":66012482,"uuid":"46739441","full_name":"bahmutov/manpm","owner":"bahmutov","description":"Shows the relevant part of NPM module's README file right in your terminal","archived":false,"fork":false,"pushed_at":"2023-09-05T18:52:15.000Z","size":192,"stargazers_count":43,"open_issues_count":4,"forks_count":213,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-12-27T20:18:56.300Z","etag":null,"topics":["cli","man","npm"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bahmutov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2015-11-23T18:21:18.000Z","updated_at":"2024-11-30T05:18:05.000Z","dependencies_parsed_at":"2024-01-11T14:26:52.956Z","dependency_job_id":null,"html_url":"https://github.com/bahmutov/manpm","commit_stats":{"total_commits":61,"total_committers":1,"mean_commits":61.0,"dds":0.0,"last_synced_commit":"e7e15a2535bc0195706c454f854c5dbc9db207ea"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bahmutov%2Fmanpm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bahmutov%2Fmanpm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bahmutov%2Fmanpm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bahmutov%2Fmanpm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bahmutov","download_url":"https://codeload.github.com/bahmutov/manpm/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234558651,"owners_count":18852278,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","man","npm"],"created_at":"2024-08-01T06:01:15.272Z","updated_at":"2025-09-28T20:30:50.950Z","avatar_url":"https://github.com/bahmutov.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Uncategorized"],"sub_categories":["Uncategorized"],"readme":"# manpm\n\n\u003e Shows the relevant part of NPM module's README file right in your terminal\n\n[![NPM][manpm-icon] ][manpm-url]\n\n[![manpm](https://img.shields.io/badge/manpm-compatible-3399ff.svg)](https://github.com/bahmutov/manpm)\n[![alternate](https://img.shields.io/badge/manpm-%E2%9C%93-3399ff.svg)](https://github.com/bahmutov/manpm)\n[![CI][ci-badge] ][ci-url]\n[![semantic-release][semantic-image] ][semantic-url]\n[![npm checklist](https://img.shields.io/badge/%E2%98%B0-%E2%9C%93-brightgreen.svg)](https://github.com/bahmutov/npm-module-checklist#readme)\n[CHECKLIST.md](CHECKLIST.md)\n\n[manpm-icon]: https://nodei.co/npm/manpm.png?downloads=true\n[manpm-url]: https://npmjs.org/package/manpm\n[ci-badge]: https://travis-ci.org/bahmutov/manpm.png?branch=master\n[ci-url]: https://travis-ci.org/bahmutov/manpm\n[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n[semantic-url]: https://github.com/semantic-release/semantic-release\n\n## Badge\n\nIf you module has API well-described in the README, and `manpm \u003ctext\u003e` works well,\nconsider adding the following `manpm compatible` badge to your README. Here is the markdown\nfor both variants: words or unicode symbols\n\n```\n[![manpm](https://img.shields.io/badge/manpm-compatible-3399ff.svg)](https://github.com/bahmutov/manpm)\n[![alternate](https://img.shields.io/badge/manpm-%E2%9C%93-3399ff.svg)](https://github.com/bahmutov/manpm)\n```\n\n## Install\n\n    npm install -g manpm\n\n## Show the entire README from a package or github repo\n\nYou can give NPM package name (like `manpm`), GitHub user / repo pair (like `bahmutov/manpm`) or\nfull GitHub url (like `https://github.com/bahmutov/object-fitter` or `git@github.com:bahmutov/object-fitter.git`).\n\n    manpm \u003cpackage name | github repo\u003e\n\nFor example `manpm email-regex` will render the README from\n[email-regex](https://www.npmjs.com/package/email-regex) package in you terminal\n\n![manpm screenshot](images/manpm-screenshot.png)\n\n## Show part of the readme\n\n    manpm \u003cpackage name\u003e [optional search text inside README]\n\nIf search text is provided, only a section of the README file with that text\n(if found) will be displayed.\n\n![manpm search section](images/search-section.png)\n\nThe following search features are implemented\n\n- [x] find exact match in the section heading text\n- [ ] fuzzy text match in the section heading text\n- [x] find exact match in the section body\n- [ ] fuzzy text match in the section body\n\nI am still looking for a library capable of fuzzy text search.\nMaybe [lunr](https://github.com/olivernn/lunr.js)?\n\n## Show and search local README\n\nSometimes you just want to find a section in the local README file, right in the current directory.\n\n    manpm . [optional search text]\n\n## Example: showing ES6 docs\n\nThere is a great GitHub repo [ES6 Overview in 350 Bullet Points](https://github.com/bevacqua/es6)\nhosted at `https://github.com/bevacqua/es6`. Let us see how we can info for `WeakSets`\n\n```\n$ manpm bevacqua/es6 weaksets\n# WeakSets\n\n    * WeakSet is sort of a cross-breed between Set and WeakMap\n    * A WeakSet is a set that can't be iterated and doesn't have enumeration methods\n    * WeakSet values must be reference types\n    * WeakSet may be useful for a metadata table indicating whether a reference is actively in use or not\n    * Read ES6 WeakSets in Depth (https://ponyfoo.com/articles/es6-weakmaps-sets-and-weaksets-in-depth#es6-weaksets)\n\n\u003csup\u003e(back to table of contents) (#table-of-contents)\u003c/sup\u003e\n```\n\nI added an alias to `manpm bevacqua/es6` command to my shell alias file for convenience\n\n    $ echo 'alias es6-docs=\"manpm bevacqua/es6\"' \u003e\u003e ~/.alias\n    source ~/.alias\n    es6-docs weaksets\n    es6-docs array\n\n## Example: showing ES6 features\n\nAnother great succint overview of ES6 features is\nin [lukehoban/es6features](https://github.com/lukehoban/es6features). Let us add an alias\n\n    echo 'alias es6-features=\"manpm lukehoban/es6features\"' \u003e\u003e ~/.alias\n    source ~/.alias\n\nLet us look up the binary notation in ES6\n\n    es6-features binary\n    ### Binary and Octal Literals\n    Two new numeric literal forms are added for binary (b) and octal (o).\n        0b111110111 === 503 // true\n        0o767 === 503 // true\n\n## Pipe through less | more\n\nYou can pipe the output of `manpm` through \"less\" or \"more\" tools - but you will\nlose the Markdown highlighting.\n\n    manpm \u003cpackage name\u003e | less\n    manpm \u003cpackage name\u003e | more\n\n## Advanced\n\nIf there are problems and `manpm` is not working as expected, you can see the debug output.\nJust run the tool with `DEBUG=manpm manpm ...` environment setting.\n\n    $ DEBUG=manpm manpm object-fitter\n    manpm fetching README for package +0ms object-fitter\n\nGood testing commands:\n\n    DEBUG=manpm npm run example-es6-docs\n\n## Inspired by the following tools\n\n* [man-n](https://github.com/man-n/man-n)\n* [npm-man](https://github.com/eush77/npm-man)\n* [readme](https://www.npmjs.com/package/readme)\n\nI wanted something a little more API friendly, like finding and showing\na README section that talked about a specific API method for example.\n\n## More examples\n\n- 📺 Watch video [Type Placeholders Into The Form: manp and cypress-await example](https://youtu.be/Z4nDKbWMkJc)\n\n### Small print\n\nAuthor: Gleb Bahmutov \u0026copy; 2015\n\n* [@bahmutov](https://twitter.com/bahmutov)\n* [glebbahmutov.com](http://glebbahmutov.com)\n* [blog](http://glebbahmutov.com/blog/)\n\nLicense: MIT - do anything with the code, but don't blame me if it does not work.\n\nSpread the word: tweet, star on github, etc.\n\nSupport: if you find any problems with this module, email / tweet /\n[open issue](https://github.com/bahmutov/manpm/issues) on Github\n\n## MIT License\n\nCopyright (c) 2015 Gleb Bahmutov\n\nPermission is hereby granted, free of charge, to any person\nobtaining a copy of this software and associated documentation\nfiles (the \"Software\"), to deal in the Software without\nrestriction, including without limitation the rights to use,\ncopy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the\nSoftware is furnished to do so, subject to the following\nconditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\nOF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\nHOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\nWHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\nFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\nOTHER DEALINGS IN THE SOFTWARE.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbahmutov%2Fmanpm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbahmutov%2Fmanpm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbahmutov%2Fmanpm/lists"}