Skip to content

A sleek and short documentation system for the terminal.

License

Notifications You must be signed in to change notification settings

Milo123459/manny

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

manny

A better, more sleek community based man page effort.

Thanks for visiting!

How

Manny is an enfort to help get more info on apps you love via the CLI. There is a seperate repo, MannyDB which is where your app information is stored. If you want to add your app to manny, or update it, you submit a PR there. On the repo you will find contribution guidelines. Make sure to follow them!

After adding, you can type manny update, which will update the DB locally. It is stored in the home dir: $HOME/.manny/db This DB folder is a cloned version of the DB repo. You need to have git installed. When you run it for the first time, each time you run a command, it checks if the DB is present. If not, it'll clone it. This should only take a few seconds. Once cloned, every file ending with .md will then be an app you can later get info on.

Manny's CLI / core (the repo you are on) is written in Rust. This allows the CLI to be ridiculously fast.

If you have any other questions, please create an issue! I'll try and help out ASAP. (Please don't make issues on the MannyDB repo, there isn't a point).

Lifecycle

manny update => Clone, or pull the git repository located in $HOME/.manny/db.
manny app <app> => Seacrh through the DB (located in $HOME/.manny/db) for an app with the name which is provided. If found, display and render the markdown.
manny is <app> => Search through the DB (located in $HOME/.manny/db) and see if the app with the name provided is in the DB.

When

Soon™

About

A sleek and short documentation system for the terminal.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published

Languages