personal-man (pman)

Note

I am archiving this project in favor of cheat, which provides the same features and more!

Personal Manpages

Installation

1. Install ripgrep

2. Install the pman CLI with pipx

   pipx install personal-man
   

3. Run pman to check that installation succeeded and to see the available commands

4. The help output will display the directory for your personal manpages, but you can change the default by exporting an environment variable: PMAN_DOC_PATH. I personally have a directory within my main Obsidian vault so that I can edit the files in Obsidian and search with pman

Usage

For more example code, see the scripts directory or the tests.

Project Status

See the Open Issues and/or the CODE_TAG_SUMMARY. For release history, see the CHANGELOG.

Contributing

We welcome pull requests! For your pull request to be accepted smoothly, we suggest that you first open a GitHub issue to discuss your idea. For resources on getting started with the code base, see the below documentation:

• DEVELOPER_GUIDE
• STYLE_GUIDE

Code of Conduct

We follow the Contributor Covenant Code of Conduct.

Open Source Status

We try to reasonably meet most aspects of the "OpenSSF scorecard" from Open Source Insights

Responsible Disclosure

If you have any security issue to report, please contact the project maintainers privately. You can reach us at dev.act.kyle@gmail.com.

License

LICENSE