ZPLUG-DEPTH(5)

πŸ’– ZPLUG-DEPTH πŸ’–

okay so bestie, we're doing the zplug-depth page from the ZPLUG Manual, and honestly? it's a whole vibe. it's all about how many commits you wanna drag along when zplug clones a repo for you. let's get into it 🫢


✨ NAME ✨

zplug-depth β€” the number of commits to include in the cloned repository πŸŽ€


🌸 SYNOPSIS 🌸

zplug "username/reponame", depth:10

quick vocab moment, bestie: the word package here means a string in this exact format: "username/reponame". that's it, that's the package. πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

so here's the tea β˜• β€” by using the depth tag, you can create a shallow clone with a history truncated to the specified number of commits. less history, less to download, iconic behavior honestly.

and listen: Depth 0 means the whole history. no truncation, no shortcuts, the entire lore. πŸ‘‘

here's the table of zplug depth tag values (yes it's a table, we're doing bullets, it's the same info i promise):

Table 1. zplug detph tag (that typo is in the original, i'm just the messenger πŸ™ˆ)

  • Possible Values β€” (non-negative number)
  • Default value β€” 0

and bestie, plot twist: you can change that default value with the zstyle command:

$ zstyle ":zplug:tag" depth 10

lowkey the move if you want every clone to be shallow by default. no cap. ✨


🌈 EXAMPLES 🌈

Shallow clone, coming right up:

$ zplug "b4b4r07/enhancd", \
    as:plugin, \
    use:enhancd.sh \
    depth:1

one commit of history, that's it, minimal queen energy πŸŽ€


πŸ‘‘ SEE ALSO πŸ‘‘


πŸ“š FURTHER DOCUMENTATION πŸ“š

See the references in official wiki page to get started using zplug. The wiki may perhaps be overwhelming for first-time users.

fr fr, if the wiki feels like a lot, that's normal β€” take it slow, bestie 🧚

πŸ’œ AUTHORS πŸ’œ

zplug was originally written by Masaki Ishiyama (a.k.a @b4b4r07). Many people have contributed to it.

shoutout to every single contributor, y'all ate πŸ”₯


πŸ“ COPYING πŸ“

Copyright (C) 2015-2016 Masaki Ishiyama

MIT License


πŸ’€ REPORTING BUGS πŸ’€

Report bugs to the zplug issues

not me begging you to actually file the issue instead of just suffering in silence 😭

and that's the whole page, bestie! this one came from the ZPLUG Manual, version dated 11/21/2016, and it lives at ZPLUG-DEPTH(5) in the manual pages. go forth and shallow clone responsibly πŸ’–βœ¨πŸ¦‹

πŸ“¦ where this page comes from