Quickstart

This page will help you get started with Phylum CLI tool. You'll be up and running in a jiffy!


Introduction

The command line interface (CLI) allows users to submit their project package dependencies to Phylum's API for analysis. Currently pre-built binaries for Linux and macOS are available. On Windows, we recommend using the Linux binaries under WSL. For more options, see Alternate Installation Methods.

asciicastasciicast

Quickstart for Linux or macOS

  1. Download the latest release package and signature file for your target:

  2. Confirm the signature of the archive with openssl and the public key for Phylum:

    $ openssl dgst -sha256 -verify signing-key.pub -signature phylum-*.zip.signature phylum-*.zip
    Verified OK
    
  3. Unzip the archive

    unzip phylum-*.zip
    
  4. Run the installer script for installation

    ./install.sh
    
  5. Register for an account (if you don't already have one)

    phylum auth register
    
  6. Authenticate with Phylum

    phylum auth login
    
  7. Create a new Phylum project in your project directory

    phylum project create <project-name>
    
  8. Submit your package lock file

    phylum analyze <package-lock-file.ext>
    
  9. (Optional) View the analysis results in the Phylum UI


License

Copyright (C) 2022 Phylum, Inc.

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License or any later version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program. If not, see https://www.gnu.org/licenses/gpl.html or write to
[email protected] or [email protected]

Slack

Join us on the Phylum Community Slack!

Questions/Issues

Please contact Phylum with any questions or issues using the CLI tool.

Email: [email protected]