Crates.io | pactup |
lib.rs | pactup |
version | 0.2.15 |
source | src |
created_at | 2024-05-27 15:04:33.047656 |
updated_at | 2024-06-01 22:10:17.241941 |
description | Fast and simple Pact version manager |
homepage | |
repository | https://github.com/kadena-community/pactup |
max_upload_size | |
id | 1253477 |
size | 522,152 |
pactup
)
🚀 Fast and simple Pact version manager, built in Rust
🌎 Cross-platform support (macOS, Windows, Linux)
✨ Single file, easy installation, instant startup
🚀 Built with speed in mind
📂 Works with .pact-version
and .pactrc
files
For bash
, zsh
and fish
shells, there's an automatic installation script.
First ensure that curl
and unzip
are already installed on you operating system. Then execute:
curl -fsSL https://raw.githubusercontent.com/kadena-community/pactup/main/scripts/install.sh | bash
Upgrading pactup
is almost the same as installing it. To prevent duplication in your shell config file add --skip-shell
to install command.
--install-dir
Set a custom directory for pactup to be installed. The default is $XDG_DATA_HOME/pactup
(if $XDG_DATA_HOME
is not defined it falls back to $HOME/.local/share/pactup
on linux and $HOME/Library/Application Support/pactup
on MacOS).
--skip-shell
Skip appending shell specific loader to shell config file, based on the current user shell, defined in $SHELL
. e.g. for Bash, $HOME/.bashrc
. $HOME/.zshrc
for Zsh. For Fish - $HOME/.config/fish/conf.d/pactup.fish
Example:
curl -fsSL https://raw.githubusercontent.com//main/scripts/install.sh | bash -s -- --install-dir "./.pactup" --skip-shell
cargo install pactup
npm install -g pactup
Then, set up your shell for pactup
PATH
environment variableTo remove pactup (😢), just delete the .pactup
folder in your home directory. You should also edit your shell configuration to remove any references to pactup (ie. read Shell Setup, and do the opposite).
pactup ships its completions with the binary:
pactup completions --shell <SHELL>
Where <SHELL>
can be one of the supported shells:
bash
zsh
fish
power-shell
Please follow your shell instructions to install them.
Environment variables need to be setup before you can start using pactup.
This is done by evaluating the output of pactup env
.
[!NOTE] Check out the Configuration section to enable highly recommended features, like automatic version switching.
Adding a .pact-version
to your project is as simple as:
$ pact --version
pact version 4.11.0
$ echo "4.11" > .pact-version
Check out the following guides for the shell you use:
Add the following to your .bashrc
profile:
eval "$(pactup env --use-on-cd)"
Add the following to your .zshrc
profile:
eval "$(pactup env --use-on-cd)"
Create ~/.config/fish/conf.d/pactup.fish
add this line to it:
pactup env --use-on-cd | source
Add the following to the end of your profile file:
pactup env --use-on-cd | Out-String | Invoke-Expression
~/.config/powershell/Microsoft.PowerShell_profile.ps1
notepad $profile
pactup is also supported but is not entirely covered. You can set up a startup script and append the following lines:
@echo off
:: for /F will launch a new instance of cmd so we create a guard to prevent an infnite loop
if not defined PACTUP_AUTORUN_GUARD (
set "PACTUP_AUTORUN_GUARD=AutorunGuard"
FOR /f "tokens=*" %%z IN ('pactup env --use-on-cd') DO CALL %%z
)
Usage is very similar to the normal WinCMD install, apart for a few tweaks to allow being called from the cmder startup script. The example assumes that the CMDER_ROOT
environment variable is set to the root directory of your Cmder installation.
Then you can do something like this:
:: %CMDER_ROOT%\bin\pactup_init.cmd
@echo off
FOR /f "tokens=*" %%z IN ('pactup env --use-on-cd') DO CALL %%z
:: %CMDER_ROOT%\config\user_profile.cmd
call "%CMDER_ROOT%\bin\pactup_init.cmd"
You can replace %CMDER_ROOT%
with any other convenient path too.
See the available configuration options for an extended configuration documentation
See the available commands for an extended usage documentation
PRs welcome :tada:
# Install Rust
git clone https://github.com/kadena-community/pactup
cd crates/pactup
cargo build
cargo run -- --help # Will behave like `pactup --help`
cargo test
Pact version manager is ported from the amazing fnm codebase.