Phylum CLI Extensions

Overview

Phylum CLI extensions are optional plugins for the CLI which provide additional functionality in a modular fashion.

Extensions are executed in a Deno JavaScript runtime and have access to Phylum's API for commonly used operations. The capability-based permission system, together with Deno's sandbox, ensures that extensions can only do what they're supposed to.

Usage

If you're interested in using existing Phylum CLI extensions, you can take a look at the CLI's extension documentation.

Writing Extensions

• Quickstart
• Manifest Format
• Extension API
• Example
• Extension Sandboxing
• Direct Phylum API Requests

TIP: More info

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

Official Extensions

Official Phylum CLI extensions can be found on GitHub. These are a great place to get started if you want to try out some CLI extensions or write your own.

Additionally, many of the official extensions are distributed with the Phylum CLI and should already be available for use. The pre-installed extensions are:

• npm
• pip
• poetry
• yarn
• bundle
• cargo