<!-- GENERATED by docs/sphinx/bin/20-reference (p5) from reference/bundled/CPAN/Plugin.md. Do not edit. -->

```{index} single: CPAN::Plugin
```

# CPAN::Plugin

Base class for CPAN shell extensions

## SYNOPSIS

```perl
package CPAN::Plugin::Flurb;
use parent 'CPAN::Plugin';

sub post_test {
  my ($self, $distribution_object) = @_;
  $self = $self->new (distribution_object => $distribution_object);
  ...;
}
```

## DESCRIPTION

### Alpha Status

The plugin system in the CPAN shell was introduced in version 2.07 and
is still considered experimental.

### How Plugins work?

See ["Plugin support" in CPAN](../CPAN.md).

## METHODS

### plugin\_requires

returns list of packages given plugin requires for functionality.
This list is evaluated using `CPAN->use_inst` method.

### distribution\_object

Get current distribution object.

### distribution

### distribution\_info

### build\_dir

Simple delegatees for misc parameters derived from distribution

### is\_xs

## AUTHOR

Branislav Zahradnik <barney@cpan.org>

## Modules

- [`CPAN::Plugin::Specfile`](Plugin/Specfile.md) - Proof of concept implementation of a trivial CPAN::Plugin

```{toctree}
:hidden:
:maxdepth: 1

Plugin/Specfile
```