16 releases

0.2.15 Jun 1, 2024
0.2.14 Jun 1, 2024
0.2.12 May 31, 2024

#63 in Development tools

Download history 525/week @ 2024-05-23 403/week @ 2024-05-30 46/week @ 2024-06-06 13/week @ 2024-06-13

545 downloads per month

GPL-3.0 license

150KB
4K SLoC

Pact version manager (pactup)

πŸš€ Fast and simple Pact version manager, built in Rust

Blazing fast!
NPM version Crates.io Version

Features

🌎 Cross-platform support (macOS, Windows, Linux)

✨ Single file, easy installation, instant startup

πŸš€ Built with speed in mind

πŸ“‚ Works with .pact-version and .pactrc files

Installation

Using a script (macOS/Linux)

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

Upgrade

Upgrading pactup is almost the same as installing it. To prevent duplication in your shell config file add --skip-shell to install command.

Parameters

--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

Manually

Using Cargo (Linux/macOS/Windows)

cargo install pactup

Using Npm (Linux/macOS/Windows)

npm install -g pactup

Then, set up your shell for pactup

Using a release binary (Linux/macOS/Windows)

Removing

To 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).

Completions

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.

Shell Setup

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:

Bash

Add the following to your .bashrc profile:

eval "$(pactup env --use-on-cd)"

Zsh

Add the following to your .zshrc profile:

eval "$(pactup env --use-on-cd)"

Fish shell

Create ~/.config/fish/conf.d/pactup.fish add this line to it:

pactup env --use-on-cd | source

PowerShell

Add the following to the end of your profile file:

pactup env --use-on-cd | Out-String | Invoke-Expression
  • For macOS/Linux, the profile is located at ~/.config/powershell/Microsoft.PowerShell_profile.ps1
  • On Windows to edit your profile you can run this in a PowerShell
    notepad $profile
    

Windows Command Prompt aka Batch aka WinCMD

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 with Cmder

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:

  • Make a .cmd file to invoke it
:: %CMDER_ROOT%\bin\pactup_init.cmd
@echo off
FOR /f "tokens=*" %%z IN ('pactup env --use-on-cd') DO CALL %%z
  • Add it to the startup script
:: %CMDER_ROOT%\config\user_profile.cmd
call "%CMDER_ROOT%\bin\pactup_init.cmd"

You can replace %CMDER_ROOT% with any other convenient path too.

Configuration

See the available configuration options for an extended configuration documentation

Usage

See the available commands for an extended usage documentation

Contributing

PRs welcome πŸŽ‰

Developing:

# Install Rust
git clone https://github.com/kadena-community/pactup
cd crates/pactup
cargo build

Running Binary

cargo run -- --help # Will behave like `pactup --help`

Running Tests

cargo test

NOTES

  • Windows is not supported because Pact does not support Windows anyway.
  • The Pact binaries are problematic; they are not consistent in each release, and often, releases are missing binaries. For example, the latest release, 4.12, does not have any Mac binaries on GitHub. Expect some issues with this.

Credit

Pact version manager is ported from the amazing fnm codebase.

Dependencies

~23–61MB
~1M SLoC