geode-sdk / cli

Command-line utilities for working w/ geode
Boost Software License 1.0
24 stars 21 forks source link

add shell completion and manpage generation #63

Closed pauliesnug closed 2 months ago

pauliesnug commented 2 months ago

adds shell completion and manpage generation via a command. here's some docs of how to use the commands: fixes #61

we can also automatically provide these files for macos, since brew provides a way to auto-install precompiled shell completions and man pages

# bash
geode completions bash > ~/.local/share/bash-completion/completions/geode
# oh-my-zsh
geode completions zsh > ~/.oh-my-zsh/completions/_geode
autoload -U compinit && compinit

man pages: Man pages are written in roff. If you have groff installed you can view the man page with geode generate-manpage | groff -mandoc -Tascii | less. (or instead of less, add it to your manpage directory). we can also automatically provide the parsed manpage on the repo and then have it installed with our homebrew tap

pauliesnug commented 2 months ago

this should be ready to merge?

pauliesnug commented 2 months ago

@matcool hi, i fixed merge conflicts

pauliesnug commented 2 months ago

@matcool why revert dep bump?

matcool commented 2 months ago

it and the reformatting of every file (because you changed the formatting rules for some reason) was outside the scope of the pr

pauliesnug commented 2 months ago

it and the reformatting of every file (because you changed the formatting rules for some reason) was outside the scope of the pr

okay ig. the docs i added should be in the docs repo i guess? or maybe just the readme of this repo?