https://github.com/polettix/app-easer

Simplify writing (hierarchical) CLI applications in Perl
https://github.com/polettix/app-easer

perl

Last synced: about 2 months ago
JSON representation

Simplify writing (hierarchical) CLI applications in Perl

• Host: GitHub
• URL: https://github.com/polettix/app-easer
• Owner: polettix
• License: other
• Created: 2021-07-02T20:33:38.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-08T15:55:25.000Z (4 months ago)
• Last Synced: 2024-09-08T17:48:24.671Z (4 months ago)
• Topics: perl
• Language: Perl
• Homepage: https://github.polettix.it/App-Easer
• Size: 841 KB
• Stars: 9
• Watchers: 1
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: Changes
  • License: LICENSE
  • Support: support/podversion.pl

Awesome Lists containing this project

README

        
# NAME

App::Easer - Simplify writing (hierarchical) CLI applications

# VERSION

This document describes App::Easer version {{\[ version \]}}.



    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    



# SYNOPSIS

    #!/usr/bin/env perl

    use v5.24;

    use experimental 'signatures';

    use App::Easer V2 => 'run';

    my $app = {

       aliases     => ['foo'],

       help        => 'this is the main app',

       description => 'Yes, this really is the main app',

       options     => [

          {

             name        => 'foo',

             help        => 'option foo!',

             getopt      => 'foo|f=s',

             environment => 'FOO',

             default     => 'bar',

          },

       ],

       execute => sub ($instance) {

          my $foo = $instance->config('foo');

          say "Hello, $foo!";

          return 0;

       },

       default_child => '-self',    # run execute by default

       children => [

          {

             aliases => ['bar'],

             help => 'this is a sub-command',

             description => 'Yes, this is a sub-command',

             execute => sub { 'Peace!' },

          },

       ],

    };

    exit run($app, $0, @ARGV);

# DESCRIPTION

**NOTE**: this software should be considered "late alpha" maturity. I'm

mostly happy with the interface, but there are still a few things that

might get changed. _Anyway_, if you find a release of `App::Easer` to

work fine for you, it's fair to assume that you will not need to get a

newer one later.

App::Easer provides the scaffolding for implementing hierarchical

command-line applications in a very fast way.

Development today happens only in [App::Easer::V2](https://metacpan.org/pod/App%3A%3AEaser%3A%3AV2). The legacy

interface is still available in [App::Easer::V1](https://metacpan.org/pod/App%3A%3AEaser%3A%3AV1), which is also the

default but has its own documentation.

# BUGS AND LIMITATIONS

Minimum perl version 5.24.

Report bugs through GitHub (patches welcome) at

[https://github.com/polettix/App-Easer](https://github.com/polettix/App-Easer).

# AUTHOR

Flavio Poletti 

# COPYRIGHT AND LICENSE

Copyright 2021, 2022 by Flavio Poletti 

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.