Registry / devops / fetch-readme

fetch-readme

JSON →
library1.0.0jsnpmunverified

A CLI tool to fetch README content from GitHub repositories by URL or stdin. Version 1.0.0 is the latest stable release. This package provides a simple command-line interface to quickly retrieve README files, supporting piped input and direct URL arguments. It's useful for developers who want to view repository READMEs without opening a browser. However, the package is in maintenance mode with no active development since 2019.

devops
npm install fetch-readme
github ↗package ↗homepage ↗
INSTALL
IMPORT
SIG · FETCH-README
F
fetch-readme
devopsjavascriptv1.0.0
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

fetch-readme CLI
✓ npx fetch-readme https://github.com/user/repo
✗ npm i -g fetch-readme && fetch-readme
Use npx to avoid global install; command-line only, no programmatic API.

Fetches and prints the README from a GitHub repository URL.

fetch-readme https://github.com/uetchy/fetch-readme
Debug
Known issues
gotchaPackage only supports GitHub URLs; non-GitHub URLs will fail silently.
fix
Ensure URL is a valid GitHub repository URL.
affects: >=1.0.0
deprecatedCLI tool with no programmatic API; cannot be used as a library.
fix
Use alternative libraries like @octokit/rest if you need to fetch READMEs programmatically.
affects: >=1.0.0
Errors
Common errors & fixes
fetch-readme: not found
Package not installed globally or not using npx.
fix
Run 'npx fetch-readme <url>' or install globally with 'npm i -g fetch-readme'.
Error: Invalid URL
Non-GitHub URL or malformed URL provided.
fix
Provide a valid GitHub repository URL, e.g., https://github.com/user/repo.
Upgrade
Version history
1.0.0latest on npm
Audit
Dependencies

No dependency data recorded yet.

Agent activity
2 hits · last 30 days
node
2
Resources
githubhttps://github.com/uetchy/fetch-readme ↗
packagefetch-readme ↗
homepagehttps://github.com/uetchy/fetch-readme ↗
fetch-readme — npm install fetch-readme · libregistry