{"id":40572604,"url":"https://github.com/foundling/node-help","last_synced_at":"2026-01-21T01:37:36.226Z","repository":{"id":31902869,"uuid":"129697094","full_name":"foundling/node-help","owner":"foundling","description":"Offline documentation for your Node REPL","archived":false,"fork":false,"pushed_at":"2025-07-13T21:45:42.000Z","size":69171,"stargazers_count":16,"open_issues_count":23,"forks_count":3,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-09-15T11:19:00.767Z","etag":null,"topics":["documentation","nodejs","repl"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/foundling.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-16T06:44:00.000Z","updated_at":"2023-06-22T20:18:54.000Z","dependencies_parsed_at":"2024-02-02T17:00:34.527Z","dependency_job_id":"9d46839a-9714-4677-baf5-d57b18c73ae6","html_url":"https://github.com/foundling/node-help","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/foundling/node-help","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foundling%2Fnode-help","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foundling%2Fnode-help/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foundling%2Fnode-help/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foundling%2Fnode-help/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/foundling","download_url":"https://codeload.github.com/foundling/node-help/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foundling%2Fnode-help/sbom","scorecard":{"id":407909,"data":{"date":"2025-08-11","repo":{"name":"github.com/foundling/node-help","commit":"e00e68c43de1ea7bea0287611653cdc4743db4fe"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":0,"reason":"Found 2/28 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":9,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Warn: project license file does not contain an FSF or OSI license."],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 4 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"21 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-p28h-cc7q-c4fg","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-ch52-vgq2-943f","Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj","Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-qxg5-2qff-p49r","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-18T21:51:27.029Z","repository_id":31902869,"created_at":"2025-08-18T21:51:27.029Z","updated_at":"2025-08-18T21:51:27.029Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28621918,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T23:49:58.628Z","status":"ssl_error","status_checked_at":"2026-01-20T23:47:29.996Z","response_time":117,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["documentation","nodejs","repl"],"created_at":"2026-01-21T01:37:36.153Z","updated_at":"2026-01-21T01:37:36.214Z","avatar_url":"https://github.com/foundling.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# node-help\n\n[![Known Vulnerabilities](https://snyk.io/test/github/foundling/node-help/badge.svg?targetFile=package.json)](https://snyk.io/test/github/foundling/node-help?targetFile=package.json)\n[![Build Status](https://travis-ci.org/foundling/node-help.svg?branch=master)](https://travis-ci.org/foundling/node-help)\n\nOffline documentation for your Node REPL.\n\n### Installing, Uninstalling and Updating `node-help`\n\nTo install `node-help`, run: \n\n````\nnpm install -g node-help\n````\n\nTo uninstall `node-help`, run: \n\n````\nnpm uninstall -g node-help\n````\n\nTo update `node-help` to the latest published version, run:\n````\nnpm update -g node-help\n````\n\n### API\n\n+ `?`: append to the end of a built-in Node object to get documentation on it\n+ `.docs`: show a list of long-form markdown articles to read\n+ `.docs \u003ctopic\u003e`: render the article name in Markdown for the terminal \n\n## The offline documentation module for the Node.js REPL \n\n+ [Features](#features)\n+ [Level of Support](#level-of-support)\n+ [API](#api)\n+ [Usage](#usage)\n  - [The `.docs` command](#the--docs--command)\n  - [The `.docs \u003ctopic\u003e` command](#the--docs--topic---command)\n  - [The `?` token](#the-----token)\n+ [Contributions](#contributions)\n\n### Features\n\n`node-help` is a custom Node.js REPL inspired by iPython that lets you append a question mark to any valid JavaScript token to get information about it.\n\n- Documentation for un-aliased built-in lookups, e.g. `node-help \u003e process.env?`.\n- Basic Native JavaScript introspection support displaying objects' valueOf(), toString(), method and property values.\n- Colorized short-and-longform documentation\n    + short-form docs are accessed with an appended `?` and are rendered in colorized plain text \n    + long-form docs are accessed via the `.docs \u003ctopic_name\u003e` command and are rendered in colorized markdown in the terminal\n- Command history and `global` context are enabled.\n\n### Level of Support\n\nAt present documentation is available for Node v8, v9 and 10. Native JavaScript documentation is coming soon, but there is rudimentary introspection for Native JavaScript objects (See the 'additional information' section of the output for any given search query'). \n\n### Usage \n\n\n#### The `.docs` command\n\nUsing the `.docs` command, you can list the available longform docs like this:\n\n````\navailable Node.js docs:\n+ addons\n+ assert\n+ async_hooks\n+ buffer\n+ child_process\n+ cli\n+ cluster\n+ console\n+ crypto\n+ debugger\n+ deprecations\n+ dgram\n+ dns\n+ documentation\n+ domain\n+ errors\n+ esm\n+ events\n+ fs\n...\n````\n\n#### The `.docs \u003ctopic\u003e` command\n\nBy running `.docs http2`, for example, you can read long-form documentation on the `http2` module from the Node.js website as colorized Markdown in your terminal. Like, wee!\n\n````javascript\n# HTTP/2\n\n    Stability: 1 - Experimental\n\n    The http2 module provides an implementation of the HTTP/2 (https://tools.ietf.org/html/rfc7540) protocol. It\n    can be accessed using:\n\n        const http2 = require('http2');\n\n        ## Core API\n\n        The Core API provides a low-level interface designed specifically around\n        support for HTTP/2 protocol features. It is specifically not designed for\n        compatibility with the existing HTTP/1 (http.html) module API. However,\n        the Compatibility API (#http2_compatibility_api) is.\n\n        The http2 Core API is much more symmetric between client and server than the\n        http API. For instance, most events, like error, connect and stream, can\n        be emitted either by client-side code or server-side code.\n\n        ### Server-side example\n\n        The following illustrates a simple HTTP/2 server using the Core API.\n        Since there are no browsers known that support\n        unencrypted HTTP/2 (https://http2.github.io/faq/#does-http2-require-encryption), the use of\n        http2.createSecureServer() (#http2_http2_createsecureserver_options_onrequesthandler) is necessary when communicating\n        with browser clients.\n\n            const http2 = require('http2');\n                const fs = require('fs');\n\n...\n````\n\n### Use the `?` to search the Node API (shorter-form)\n\n````javascript\nnode-help \u003e process?\n\n[ 2 Result(s) for Node.js. ]\n\n global | process \nName: process\nNode.js Object Type: global\nSignature(s): process \n\nDescription:\n{Object}\n\nThe process object. See the process object section.\n\n ChildProcess | process \nName: process\nNode.js Object Type: ChildProcess\nSignature(s): `process` {ChildProcess}  \n\nDescription:\nAll workers are created using child_process.fork(), the returned object\nfrom this function is stored as .process. In a worker, the global process\nis stored.\nSee: Child Process module\nNote that workers will call process.exit(0) if the 'disconnect' event occurs\non process and .exitedAfterDisconnect is not true. This protects against\naccidental disconnection.\n\n[ Additional Information ]\n\ntoString: '[object process]'\nvalueOf: '[object process]'\nConstructor: process\nlocal properties (non-methods):\n\n_events        arch           debugPort      execPath       pid            stderr         version        \n_eventsCount   argv           domain         features       platform       stdin          versions       \n_exiting       argv0          env            mainModule     ppid           stdout         \n_maxListeners  config         execArgv       moduleLoadList release        title          \n\nlocal methods:\n_debugEnd                           binding                             initgroups                          \n_debugPause                         chdir                               kill                                \n_debugProcess                       cpuUsage                            memoryUsage                         \n_fatalException                     cwd                                 nextTick                            \n_getActiveHandles                   dlopen                              openStdin                           \n_getActiveRequests                  emitWarning                         reallyExit                          \n_kill                               exit                                setUncaughtExceptionCaptureCallback \n_linkedBinding                      getegid                             setegid                             \n_rawDebug                           geteuid                             seteuid                             \n_startProfilerIdleNotifier          getgid                              setgid                              \n_stopProfilerIdleNotifier           getgroups                           setgroups                           \n_tickCallback                       getuid                              setuid                              \nabort                               hasUncaughtExceptionCaptureCallback umask                               \nassert                              hrtime                              uptime                              \n\nnode-help \u003e\n\n````\n\n### Contributions\n\nSee [Contributing](https://github.com/foundling/node-help/blob/master/CONTRIBUTING.md). The search algorithm for `node-help` is not perfect so there will be bugs.  Please feel free to raise issues on the [github issues page](https://github.com/foundling/node-help/issues).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoundling%2Fnode-help","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffoundling%2Fnode-help","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoundling%2Fnode-help/lists"}