Command::Runner(3pm) User Contributed Perl Documentation Command::Runner(3pm)

# [NAME](#NAME)

Command::Runner - run external commands and Perl code refs

# [SYNOPSIS](#SYNOPSIS)

```
  use Command::Runner;
  my $cmd = Command::Runner->new(
    command => ['ls', '-al'],
    timeout => 10,
    stdout  => sub ($line) { warn "out: $line\n" },
    stderr  => sub ($line) { warn "err: $line\n" },
  );
  my $res = $cmd->run;
```

# [DESCRIPTION](#DESCRIPTION)

Command::Runner runs external commands and Perl code refs

# [METHODS](#METHODS)

## [new](#new)

A constructor, which takes:

[command](#command)

an array of external commands, a string of external programs, or a Perl code ref. If an array of external commands is specified, it is automatically quoted on Windows.

[timeout](#timeout)

timeout second. You can set float second.

[redirect](#redirect)

if this is true, stderr redirects to stdout

[keep](#keep)

by default, even if stdout/stderr is consumed, it is preserved for return value. You can disable this behavior by setting keep option false.

stdout / stderr

a code ref that will be called whenever stdout/stderr is available

[env](#env)

set environment variables.

```
  Command::Runner->new(..., env => \%env)->run
    
```

is roughly equivalent to

```
  {
    local %ENV = %env;
    Command::Runner->new(...)->run;
  }
    
```

[cwd](#cwd)

set the current directory.

```
  Command::Runner->new(..., cwd => $dir)->run
    
```

is roughly equivalent to

```
  {
    require File::pushd;
    my $guard = File::pushd::pushd($dir);
    Command::Runner->new(...)->run;
  }
    
```

## [run](#run)

Run command. It returns a hash reference, which contains:

[result](#result)

[timeout](#timeout~2)

[stdout](#stdout)

[stderr](#stderr)

[pid](#pid)

# [MOTIVATION](#MOTIVATION)

I develop a CPAN client App::cpm, where I need to execute external commands and Perl code refs with:

[timeout](#timeout~3)

[quoting](#quoting)

[flexible logging](#flexible)

While App::cpanminus has excellent APIs for such use, I still needed to tweak them in App::cpm.

So I ended up creating a seperate module, Command::Runner.

# [ARTIFACT ATTESTATIONS](#ARTIFACT_ATTESTATIONS)

GitHub Artifact Attestations are generated for release tarballs uploaded to CPAN. If you care about provenance for the uploaded tarballs, see:

<https://github.com/skaji/Command-Runner/attestations>

# [COPYRIGHT AND LICENSE](#COPYRIGHT_AND_LICENSE)

Copyright 2017 Shoichi Kaji <skaji@cpan.org>

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

2026-08-01 perl v5.44.0

---

Document: Command::Runner(3pm) from perl-command-runner 1.0.0-r2 (Chainguard OS)
Source: https://github.com/skaji/Command-Runner