github-mirror/oh-my-fish
2
0
Fork 0
mirror of https://github.com/oh-my-fish/oh-my-fish.git synced 2024-11-23 07:05:33 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

implements help for commands

Browse Source
This commit is contained in:
Gabriel Marquez 2015-08-29 16:42:34 -03:00
parent 1c144d561f
commit 3acfae98b1
2 changed files with 168 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

178
pkg/omf/cli/omf.help.fish
View File

@ -1,24 +1,162 @@
function omf.help
echo \n"\
"(omf::dim)"Usage"(omf::off)"
omf "(omf::em)"action"(omf::off)" [options]
function omf.help -a type_flag
switch $type_flag
case "i" "install" "get"
echo \n"\
Install and list packages.
"(omf::dim)"Actions"(omf::off)"
"(omf::em)"l"(omf::off)"ist List local packages.
"(omf::em)"d"(omf::off)"escribe Get information about what packages do.
"(omf::em)"i"(omf::off)"nstall Install one or more packages.
"(omf::em)"t"(omf::off)"heme List / Use themes.
"(omf::em)"r"(omf::off)"emove Remove a theme or package.
"(omf::em)"u"(omf::off)"pdate Update Oh My Fish.
"(omf::em)"c"(omf::off)"d Change directory to plugin/theme directory.
"(omf::em)"n"(omf::off)"ew Create a new package from a template.
"(omf::em)"s"(omf::off)"ubmit Submit a package to the registry.
"(omf::em)"q"(omf::off)"uery Query environment variables.
"(omf::em)"destroy"(omf::off)" Uninstall Oh My Fish.
"(omf::dim)"Usage:"(omf::off)"
omf install List available packages to install
omf install "(omf::em)"<name>"(omf::off)" | "(omf::em)"<url>"(omf::off)" Install package by name or URL
"(omf::dim)"Options"(omf::off)"
"(omf::em)"--h"(omf::off)"elp Display this help.
"(omf::em)"--v"(omf::off)"ersion Display version.
"(omf::dim)"Examples:"(omf::off)"
omf install
omf install brew
omf install https://github.com/oh-my-fish/plugin-brew
"
For more information visit → "(omf::em)"git.io/oh-my-fish"(omf::off)\n
case "u" "up" "upd" "update"
echo \n"\
Update Oh My Fish.
"(omf::dim)"Usage:"(omf::off)"
omf update
"
case "destroy"
echo \n"\
Uninstall Oh My Fish.
"(omf::dim)"Usage:"(omf::off)"
omf destroy
"
case "l" "li" "lis" "lst" "list"
echo \n"\
List local packages.
"(omf::dim)"Usage:"(omf::off)"
omf list
"
case "t" "theme"
echo \n"\
Install and list themes.
"(omf::dim)"Usage:"(omf::off)"
omf theme List available themes to install
omf theme "(omf::em)"<name>"(omf::off)" Install theme by name
"(omf::dim)"Examples:"(omf::off)"
omf theme
omf theme l
"
case "r" "rem" "rm" "remove" "uninstall"
echo \n"\
Remove a theme or package.
"(omf::dim)"Usage:"(omf::off)"
omf remove "(omf::em)"<package name>"(omf::off)" | "(omf::em)"<theme name>"(omf::off)" Removes a theme or package by name
"(omf::dim)"Examples:"(omf::off)"
omf remove brew
omf remove l
"
case "c" "cd"
echo \n"\
Change directory to root or plugin/theme directory.
"(omf::dim)"Usage:"(omf::off)"
omf cd Change to Oh My Fish root folder
omf cd "(omf::em)"<package name>"(omf::off)" | "(omf::em)"<theme name>"(omf::off)" Change to plugin or theme directory by name
"(omf::dim)"Examples:"(omf::off)"
omf cd
omf cd brew
omf cd l
"
case "n" "nw" "new"
echo \n"\
Create a new package from a template.
"(omf::dim)"Usage:"(omf::off)"
omf new ("(omf::dim)"pkg"(omf::off)" | "(omf::dim)"theme"(omf::off)") "(omf::em)"<name>"(omf::off)" Create a new package from a template
"(omf::dim)"Examples:"(omf::off)"
omf new pkg mypkg
omf new theme mytheme
"
case "s" "su" "sub" "submit"
echo \n"\
Submit a package to the registry.
"(omf::dim)"Usage:"(omf::off)"
omf submit ("(omf::dim)"pkg"(omf::off)" | "(omf::dim)"theme"(omf::off)") "(omf::em)"<url>"(omf::off)" Submit a package or theme to the registry
"(omf::dim)"Examples:"(omf::off)"
omf submit pkg https://github.com/oh-my-fish/plugin-mypkg
omf submit theme https://github.com/oh-my-fish/plugin-mythemes
"
case "q" "query"
echo \n"\
Query environment variables.
"(omf::dim)"Usage:"(omf::off)"
omf query ["(omf::em)"<name>"(omf::off)"] Query environment variables
"(omf::dim)"Examples:"(omf::off)"
omf query
omf query path
omf query version
"
case "d" "desc" "describe"
echo \n"\
Get information about what packages do.
"(omf::dim)"Usage:"(omf::off)"
omf describe Get information from all available packages
omf describe "(omf::em)"<name>"(omf::off)" Get information from package by name
"(omf::dim)"Examples:"(omf::off)"
omf describe
omf describe brew
"
case "*"
echo \n"\
\$ omf [command] [arguments]
"(omf::dim)"Usage:"(omf::off)"
omf "(omf::em)"install"(omf::off)" [<name>|<url>]
omf "(omf::em)"theme"(omf::off)" [<name>]
omf "(omf::em)"remove"(omf::off)" [<name>]
omf "(omf::em)"update"(omf::off)"
omf "(omf::em)"help"(omf::off)" [<command>]
"(omf::dim)"Commands:"(omf::off)"
"(omf::em)"l"(omf::off)"ist List local packages.
"(omf::em)"d"(omf::off)"escribe Get information about what packages do.
"(omf::em)"i"(omf::off)"nstall Install one or more packages.
"(omf::em)"t"(omf::off)"heme List / Use themes.
"(omf::em)"r"(omf::off)"emove Remove a theme or package.
"(omf::em)"u"(omf::off)"pdate Update Oh My Fish.
"(omf::em)"c"(omf::off)"d Change directory to plugin/theme directory.
"(omf::em)"n"(omf::off)"ew Create a new package from a template.
"(omf::em)"s"(omf::off)"ubmit Submit a package to the registry.
"(omf::em)"q"(omf::off)"uery Query environment variables.
"(omf::em)"destroy"(omf::off)" Uninstall Oh My Fish.
"(omf::em)"help"(omf::off)" Shows help about a specific action.
"(omf::dim)"Options:"(omf::off)"
"(omf::em)"--h"(omf::off)"elp Display this help.
"(omf::em)"--v"(omf::off)"ersion Display version."
echo \n"\
For more information visit → "(omf::em)"git.io/oh-my-fish"(omf::off)\n
end
end

12
pkg/omf/omf.fish
View File

@ -35,7 +35,11 @@ end
function omf -d "Oh My Fish"
if test (count $argv) -eq 0
omf.help; and return 0
omf.help "main"; and return 0
else
if test $argv[-1] = "--help" -a (count $argv) = 2
omf.help $argv[1..-2]; and return 0
end
end
switch $argv[1]
@ -55,7 +59,11 @@ function omf -d "Oh My Fish"
end
case "-h*" "--h*" "help"
omf.help
if test (count $argv) -eq 1
omf.help "main"
else
omf.help $argv[2]
end
case "c" "cd"
switch (count $argv)