Quickstart

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 tap phylum-dev/cli
brew install phylum

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

Quickstart for Linux or macOS

Register for an account (if you don't already have one)
```
phylum auth register
```
Authenticate with Phylum
```
phylum auth login
```
Setup your Phylum project in your project directory
```
phylum init
```
Submit your lockfiles and manifests to analyze dependencies
```
phylum analyze
```
(Optional) View the analysis results in the Phylum UI

License

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]

Discord

Join us on the Phylum Community Discord!

Questions/Issues

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

Email: [email protected]