29 lines
583 B
Markdown
29 lines
583 B
Markdown
|
# posh
|
||
|
|
|
||
|
|
> Gems documentation browser for Ruby developers.
|
||
|
|
> More information: <https://poshtui.com/docs>.
|
||
|
|
|
||
|
|
- Download documentation to your machine (run inside a Ruby project) and print full sync report:
|
||
|
|
|
||
|
|
`posh sync --full`
|
||
|
|
|
||
|
|
- Start the interactive documentation browser for the current project:
|
||
|
|
|
||
|
|
`posh`
|
||
|
|
|
||
|
|
- Clear all docsets from your machine:
|
||
|
|
|
||
|
|
`posh clear`
|
||
|
|
|
||
|
|
- Generate the autocompletion script for your shell:
|
||
|
|
|
||
|
|
`posh completion {{bash|fish|powershell|zsh}}`
|
||
|
|
|
||
|
|
- Display help:
|
||
|
|
|
||
|
|
`posh {{[-h|--help]}}`
|
||
|
|
|
||
|
|
- Display help for a specific subcommand:
|
||
|
|
|
||
|
|
`posh {{subcommand}} {{[-h|--help]}}`
|