The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
App-VTide-v0.1.5
River stage zero No dependents
1 ++
/ App::VTide::Command::Init

NAME

App::VTide::Command::Init - Initialize an session configuration file

VERSION

This documentation refers to App::VTide::Command::Init version 0.1.5

SYNOPSIS

    vtide init [(-n|--name) name] [(-d|--dir) dir] [(-w|--windows) num]
    vtide init [--help|--man]

  OPTIONS:
    -n --name[=]str Name of the project (Default is the current directory name)
    -d --dir[=]str  Use this as the current directory
    -w --windows[=]int
                    The number of tmux windows to create when starting
    -f --force      Force the overwritting of existing .vtide.yml file when found
       --help       Show this help
       --man        Show the full man page

DESCRIPTION

SUBROUTINES/METHODS

run ()

Initialize the configuration file

auto_complete ()

NoOp.

details_sub ()

Returns the commands details.

HOOKS

init_config ($config)

This hook is called after the default configuration is created but before it's saved. The variable $config is a reference so modifications to it will be written to the generated .vtide.yml file.

init_name ($name)

This allows the modification of the generated project name. The variable $name is a string reference so it can be modified.

DIAGNOSTICS

CONFIGURATION AND ENVIRONMENT

DEPENDENCIES

INCOMPATIBILITIES

BUGS AND LIMITATIONS

There are no known bugs in this module.

Please report problems to Ivan Wills (ivan.wills@gmail.com).

Patches are welcome.

AUTHOR

Ivan Wills - (ivan.wills@gmail.com)

LICENSE AND COPYRIGHT

Copyright (c) 2016 Ivan Wills (14 Mullion Close, Hornsby Heights, NSW Australia 2077). All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic. 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.