pi-readme

Pi-native README generator and linter for pi.dev packages — auto-generate and validate README.md files

Packages

Package details

package

Install pi-readme from npm and Pi will load the resources declared by the package manifest.

npm report
$ pi install npm:pi-readme
Package
pi-readme
Version
1.0.0
Published
Jun 25, 2026
Downloads
160/mo · 5/wk
Author
realvendex
License
MIT
Types
package
Size
20.1 KB
Dependencies
0 dependencies · 2 peers

Security note

Pi packages can execute code and influence agent behavior. Review the source before installing third-party packages.

README

pi-readme

Pi-native README generator and linter for pi.dev packages — auto-generate and validate README.md files.

npm version

Installation

pi install npm:pi-readme

What It Does

Auto-generates and validates README.md files for pi.dev packages. Reads your package.json, extension tools, and CHANGELOG.md to create a pi-native README with proper install commands, tools documentation, and peer dependencies.

Keywords: pi-package, pi, readme, documentation, generator, linter

Tools

readme_generate

Generate a README.md for a pi.dev package from package.json metadata, extension tools, and changelog. Creates a pi-native README with proper install commands, tools documentation, and peer dependencies.

Parameters:

  • path (string, optional) — Path to the package directory (defaults to cwd)
  • template_overrides (Record<string, string>, optional) — Optional overrides for template sections

Example:

Use the readme_generate tool with path="./my-pi-package"

readme_lint

Validate a README.md against pi.dev best practices. Checks for install commands, proper pi install npm: format, description, tools section, license, heading hierarchy, and pi-package keyword.

Parameters:

  • readme_path (string, optional) — Path to the README.md file (defaults to ./README.md)
  • package_path (string, optional) — Path to the package directory (defaults to cwd)

Example:

Use the readme_lint tool to check your README

Commands

/readme generate [path]

Generate README for a pi.dev package.

/readme lint [path]

Validate README against pi.dev standards.

Peer Dependencies

  • @earendil-works/pi-coding-agent >=0.74.0
  • typebox >=1.0.0

Version: 1.0.0

Resources

License

MIT