ZPLUG-FROM(5)

✨ NAME ✨

okay bestie, this is zplug-from β€” it's the manual page (section 5, from the ZPLUG Manual) that tells you how to pick the service you install from πŸ’…


🌸 SYNOPSIS 🌸

zplug "username/reponame", from:plugin

and btw, whenever we say package in here, we mean a string shaped exactly like this: "username/reponame". that's the whole thing. that's the package. πŸŽ€


πŸ¦‹ DESCRIPTION πŸ¦‹

so the from tag is literally you choosing whether the package you're installing shows up as a plugin or as a command. that's it. that's the vibe check. ✨

here's the tea on what values the from tag actually accepts, and which one you get if you don't say anything:

  • possible values: github, gitlab, bitbucket, gh-r, gist, oh-my-zsh, local
  • default value: github

(yeah, github is the main character unless you say otherwise πŸ‘‘)

and if you want to change that default for real, you can do it with the zstyle command:

$ zstyle ":zplug:tag" from local

boom. default changed. no cap. πŸ”₯


πŸŽ€ EXAMPLES πŸŽ€

install straight from oh-my-zsh:

$ zplug "plugins/git", \
    as:plugin, \
    from:oh-my-zsh

install from a gist:

$ zplug "b4b4r07/79ee61f7c140c63d2786" \
    as:command, \
    from:gist

install from local (your own machine, your own files, we love her πŸ’–):

$ zplug "~/.zsh/plugins/brew" \
    from:local, \
    use:"*.sh"

πŸ’œ SEE ALSO πŸ’œ


🌈 FURTHER DOCUMENTATION 🌈

the references in the official wiki page are where you go to get started with zplug, fr fr. but real talk β€” if it's your first time using it, the wiki might lowkey feel a lot. it's giving overwhelming. you got this tho. 🫢


πŸ’… AUTHORS πŸ’…

zplug was originally written by Masaki Ishiyama (a.k.a @b4b4r07). and then so many people contributed to it β€” iconic behaviour, honestly. πŸ‘‘


⭐ COPYING ⭐

Copyright (C) 2015-2016 Masaki Ishiyama

MIT License


😭 REPORTING BUGS 😭

found a bug? report bugs to the zplug issues. do it. don't just sit there with the knowledge. πŸ’€


and that's the page bestie!! this one's from the ZPLUG Manual, dated 11/21/2016 β€” ZPLUG-FROM(5), section 5 of the ZPLUG Manual, wrapping up right here. mwah πŸ’–βœ¨

πŸ“¦ where this page comes from