Get started
Aside from Zsh and Python, the only dependency you're likely to need is
fzf
.
For more details and recommended package manager commands, see Dependencies.
To install zpy
itself, you only need to source the file zpy.plugin.zsh
in your Zsh startup (~/.zshrc
, or sometimes ~/.config/zsh/.zshrc
).
When using a plugin manager, you'll likely need to feed it the
"GitHub User
/Repo Name
" format, which is "andydecleyre/zpy
".
For more details and recommended plugin manager commands, see Installation.
For now, let's just source it in the current session:
% git clone https://github.com/andydecleyre/zpy ~/.zpy
% . ~/.zpy/zpy.plugin.zsh
The user-facing functions are all available as subcommands to zpy
.
Try typing zpy
, then a space, then tab.
Tip
Everything zpy does will generally be much faster if uv is installed.
You can now install it with zpy's pipz
command:
% pipz install uv
Info
By default, each function is also available directly, as a "top-level" command1.
This can be prevented by explicitly specifying a list of functions to expose,
before sourcing the plugin.
This example will expose only the pipz
and zpy
functions
(the rest remaining available as subcommands):
% zstyle ':zpy:*' exposed-funcs pipz zpy
From here, you may want to:
- continue to the next page, for an idea of how these tools can help manage a project
- jump to the full reference
- jump to
pipz
, a pipx alternative
Tip
You can flip through these docs with n
and p
, or .
and ,
.
-
Well, except for
zpy mkbin
andzpy help
. ↩