Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phylum-dev/cli
Command line interface for the Phylum API
https://github.com/phylum-dev/cli
cli malware malware-detection rust secure-software-supply-chain security security-scan software-supply-chain software-supply-chain-security supply-chain vulnerabilities
Last synced: about 9 hours ago
JSON representation
Command line interface for the Phylum API
- Host: GitHub
- URL: https://github.com/phylum-dev/cli
- Owner: phylum-dev
- License: gpl-3.0
- Created: 2021-03-19T14:21:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T19:51:07.000Z (21 days ago)
- Last Synced: 2024-10-29T21:38:37.643Z (21 days ago)
- Topics: cli, malware, malware-detection, rust, secure-software-supply-chain, security, security-scan, software-supply-chain, software-supply-chain-security, supply-chain, vulnerabilities
- Language: Rust
- Homepage: https://phylum.io
- Size: 4 MB
- Stars: 103
- Watchers: 8
- Forks: 11
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Support: docs/supported_lockfiles.md
Awesome Lists containing this project
README
---
# Introduction
[](https://github.com/phylum-dev/cli/releases/latest/)
[](https://github.com/phylum-dev/cli/blob/main/LICENSE)
[](https://github.com/phylum-dev/cli/actions/workflows/test.yml)
[](https://docs.phylum.io)
The Phylum command line interface (CLI) allows users to submit their project package dependencies to [Phylum's](https://phylum.io) API for analysis. Currently [pre-built binaries](https://github.com/phylum-dev/cli/releases) for Linux and macOS are available. On Windows, we recommend using the Linux binaries under [WSL](https://learn.microsoft.com/en-us/windows/wsl/). See the [alternate installation methods](https://docs.phylum.io/cli/alternate_install) for more options.
## Install `phylum` CLI
### Install on Linux
Install on Linux with the following command:
```sh
curl https://sh.phylum.io/ | sh -
```
### Install on macOS
On macOS, we recommend installing phylum with [Homebrew](https://brew.sh/):
```sh
brew install phylum
```
> **Note:** When using Homebrew, [official extensions][] must be installed separately.
[official extensions]: https://github.com/phylum-dev/cli/tree/main/extensions
## Quickstart for Linux or macOS
1. [Register](https://docs.phylum.io/cli/commands/phylum_auth_register) for an account (if you don't already have one)
```sh
phylum auth register
```
1. [Authenticate](https://docs.phylum.io/cli/commands/phylum_auth_login) with Phylum
```sh
phylum auth login
```
1. [Setup your Phylum project](https://docs.phylum.io/cli/commands/phylum_init) in your project directory
```sh
phylum init
```
1. [Submit your lockfiles and manifests](https://docs.phylum.io/cli/commands/phylum_analyze) to [analyze dependencies](https://docs.phylum.io/cli/commands/analyzing_dependencies)
```sh
phylum analyze
```
1. (Optional) View the analysis results in the [Phylum UI](https://app.phylum.io/auth/login)
## 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:
### How-tos
How-to articles for the extension framework can be found [here](https://dev.to/phylum).
## 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][debian-slim] instead.
[debian-slim]: https://hub.docker.com/_/debian
## 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 or write to
`[email protected]` or `[email protected]`
---
## Discord
Join us on the [Phylum Community Discord](https://discord.gg/c9QnknWxm3)!
## Questions/Issues
Please contact Phylum with any questions or issues using the CLI tool.
Email: