Skip to content

installation.md

Latest commit

 

History

History
63 lines (47 loc) · 2.13 KB

installation.md

File metadata and controls

63 lines (47 loc) · 2.13 KB

Installation

Installation script

The simplest way to install phanalist is to use the installation script.

curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/denzyldick/phanalist/main/bin/init.sh | sh

It will automatically download executable for your platform.

~/phanalist -V
phanalist 1.0.0

Pre-compiled architecture-specific binary.

You can also manually download your platform-specific binary.

Compile from source

Alternatively, you can compile it from sources on your local:

# Install RUST
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# Get the latest sources
git clone git@github.com:denzyldick/phanalist.git && cd phanalist
# Compile
cargo build -r
# Run the compiled executable
./target/release/phanalist -V

Composer

Also, you can install phanalist with Composer.

# Install package
composer require denzyl/phanalist
# Run executable
vendor/bin/phanalist -v

Docker

Another option is to use official docker image, by running the command at the root of your project:

docker run -it -v $(pwd):/var/src ghcr.io/denzyldick/phanalist:latest phanalist --src=/var/src

Github action

Phanalist is also listed on the Github action marketplace.

              - name: Phanalist
                uses: denzyldick/phanalist-action@v0.1.21