https://github.com/nichtich/git-repository-plugin-status

Git::Repository plugin to show the working tree status
https://github.com/nichtich/git-repository-plugin-status

Last synced: 5 days ago
JSON representation

Git::Repository plugin to show the working tree status

• Host: GitHub
• URL: https://github.com/nichtich/git-repository-plugin-status
• Owner: nichtich
• License: other
• Created: 2013-08-19T20:45:06.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2014-08-14T12:26:58.000Z (over 10 years ago)
• Last Synced: 2024-10-30T16:24:21.323Z (about 2 months ago)
• Language: Perl
• Homepage: https://metacpan.org/release/Git-Repository-Plugin-Status
• Size: 173 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: Changes
  • License: LICENSE

Awesome Lists containing this project

README

        
# NAME

Git::Repository::Plugin::Status - Show the working tree status

# SYNOPSIS

    # load the Status plugin

    use Git::Repository 'Status';

    # get the status of all files, including ignored files

    my @status = Git::Repository->new->status('--ignored');

    # print all tracked files

    for (@status) {

        say $_->path1 if $_->tracked;

    }

# DESCRIPTION

This module adds method `status` to module [Git::Repository](https://metacpan.org/pod/Git::Repository) to get the

status of a git working tree in form of [Git::Repository::Status](https://metacpan.org/pod/Git::Repository::Status) objects. See

[Git::Repository::Status](https://metacpan.org/pod/Git::Repository::Status) for how to make use of the status information.

# OPTIONS

The following options to the git status command can be used:

- -u\[\] or --untracked-files\[=\]

    Include untracked files with modes `no`, `normal`, or `all`.

- --ignored

    Include ignored files.

- --ignore-submodules\[=\]

    Ignore changes to submodules when looking for changes (`none`, `untracked`,

    `dirty` or `all`).

# SEE ALSO

[https://www.kernel.org/pub/software/scm/git/docs/git-status.html](https://www.kernel.org/pub/software/scm/git/docs/git-status.html)

# AUTHOR

Jakob Voß

# COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Jakob Voß.

This is free software; you can redistribute it and/or modify it under the same

terms as the Perl 5 programming language system itself.