Skip to content

Latest commit

 

History

History
115 lines (73 loc) · 3.95 KB

README.md

File metadata and controls

115 lines (73 loc) · 3.95 KB
Raw

Introduction

GitHub release (latest by date) License Test Status Docusaurus

The Phylum 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. See the alternate installation methods for more options.

Install phylum CLI

Install on Linux

Install on Linux with the following command:

curl https://sh.phylum.io/ | sh -

Install on macOS

On macOS, we recommend installing phylum with Homebrew:

brew install phylum

Note: When using Homebrew, official extensions must be installed separately.

Quickstart for Linux or macOS

  1. Register for an account (if you don't already have one)

    phylum auth register

  2. Authenticate with Phylum

    phylum auth login

  3. Setup your Phylum project in your project directory

    phylum init

  4. Submit your lockfiles and manifests to analyze dependencies

    phylum analyze

  5. (Optional) View the analysis results in the Phylum UI

Extensions

Phylum CLI extensions allow you to extend the existing CLI functionality with new features. You can start exploring by taking a look at the official Phylum extensions:

https://github.com/phylum-dev/cli/tree/main/extensions

How-tos

How-to articles for the extension framework can be found here.

musl binaries

As of version 3.8.0, the provided Linux binaries of the Phylum CLI depend on glibc. We no longer provide binaries that are statically compiled with the musl libc.

This means the provided binaries won't be executable in environments such as Alpine Linux. If your use case requires a lightweight Docker base image, consider using Debian slim instead.

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 phylum@phylum.io or engineering@phylum.io

Discord

Join us on the Phylum Community Discord!

Questions/Issues

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

Email: support@phylum.io