Commands - libvcs.cmd

Compare to: fabtools.git, salt.modules.git, ansible.builtin.git

Warning

All APIs are considered experimental and subject to break pre-1.0. They can and will break between versions.

Overview

The libvcs.cmd module provides Python wrappers for VCS command-line tools:

• libvcs.cmd.git - Git commands with Managers for intuitive entity traversal and Commands for targeted execution

• libvcs.cmd.hg - Mercurial commands

• libvcs.cmd.svn - Subversion commands

When to use cmd vs sync

Module	Use Case
libvcs.cmd	Fine-grained control over individual VCS commands
libvcs.sync	High-level repository cloning and updating

API

• libvcs.cmd.git
  • Managers and Commands
    • Quick Example
      • submodule
        • Overview
          • Example
        • API Reference
          • GitSubmoduleManager
            • __init__()
            • path
            • run()
            • add()
            • init()
            • update()
            • foreach()
            • sync()
            • summary()
            • absorbgitdirs()
            • _ls()
            • ls()
            • get()
            • filter()
          • GitSubmodule
            • name
            • path
            • url
            • sha
            • branch
            • status_prefix
            • _cmd
            • cmd
            • initialized
            • __init__()
          • GitSubmoduleEntryCmd
            • __init__()
            • path
            • run()
            • init()
            • update()
            • deinit()
            • set_branch()
            • set_url()
            • status()
            • absorbgitdirs()
          • GitSubmoduleCmd
            • __init__()
            • path
            • run()
            • init()
            • update()
      • remote
        • Overview
          • Example
        • API Reference
          • GitRemoteManager
            • remote_name
            • __init__()
            • path
            • run()
            • add()
            • show()
            • _ls()
            • ls()
            • get()
            • filter()
          • GitRemoteCmd
            • __init__()
            • path
            • remote_name
            • fetch_url
            • push_url
            • run()
            • rename()
            • remove()
            • show()
            • prune()
            • get_url()
            • set_url()
            • set_branches()
            • set_head()
            • update()
      • stash
        • Overview
          • Example
        • API Reference
          • GitStashManager
            • __init__()
            • path
            • run()
            • push()
            • clear()
            • _ls()
            • ls()
            • get()
            • filter()
          • GitStashEntryCmd
            • __init__()
            • path
            • index
            • branch
            • message
            • stash_ref
            • run()
            • show()
            • apply()
            • pop()
            • drop()
            • create_branch()
          • GitStashCmd
            • __init__()
            • path
            • run()
            • ls()
            • push()
            • pop()
            • save()
      • branch
        • Overview
          • Example
        • API Reference
          • GitBranchManager
            • branch_name
            • __init__()
            • path
            • run()
            • checkout()
            • create()
            • _ls()
            • ls()
            • get()
            • filter()
          • GitBranchCmd
            • __init__()
            • path
            • branch_name
            • run()
            • checkout()
            • create()
            • delete()
            • rename()
            • copy()
            • set_upstream()
            • unset_upstream()
            • track()
      • tag
        • Overview
          • Example
        • API Reference
          • GitTagManager
            • __init__()
            • path
            • run()
            • create()
            • _ls()
            • ls()
            • get()
            • filter()
          • GitTagCmd
            • __init__()
            • path
            • tag_name
            • run()
            • delete()
            • verify()
            • show()
      • worktree
        • Overview
          • Example
        • API Reference
          • GitWorktreeManager
            • __init__()
            • path
            • run()
            • add()
            • prune()
            • _ls()
            • ls()
            • get()
            • filter()
          • GitWorktreeCmd
            • __init__()
            • path
            • run()
            • remove()
            • lock()
            • unlock()
            • move()
            • repair()
      • notes
        • Overview
          • Example
        • API Reference
          • GitNotesManager
            • __init__()
            • path
            • run()
            • add()
            • prune()
            • merge()
            • get_ref()
            • _ls()
            • ls()
            • get()
            • filter()
          • GitNoteCmd
            • __init__()
            • path
            • run()
            • show()
            • remove()
            • append()
            • edit()
            • copy()
      • reflog
        • Overview
          • Example
        • API Reference
          • GitReflogManager
            • __init__()
            • path
            • run()
            • show()
            • expire()
            • exists()
            • _ls()
            • ls()
            • get()
            • filter()
          • GitReflogEntryCmd
            • __init__()
            • path
            • run()
            • show()
            • delete()
          • GitReflogEntry
            • __init__()
            • sha
            • refspec
            • action
            • message
            • _cmd
            • cmd
      • Git
        • __init__()
        • path
        • progress_callback
        • submodule
        • submodules
        • remotes
        • stash
        • stashes
        • branches
        • tags
        • worktrees
        • notes
        • reflog
        • run()
        • clone()
        • fetch()
        • rebase()
        • pull()
        • init()
        • help()
        • reset()
        • checkout()
        • status()
        • config()
        • version()
        • rev_parse()
        • rev_list()
        • symbolic_ref()
        • show_ref()
• libvcs.cmd.hg
  • HgColorType
    • boolean
    • always
    • auto
    • never
    • debug
  • HgPagerType
    • boolean
    • always
    • auto
    • never
  • Hg
    • __init__()
    • path
    • progress_callback
    • run()
    • clone()
    • update()
    • pull()
• libvcs.cmd.svn
  • SvnPropsetValueOrValuePathRequired
    • __init__()
  • Svn
    • __init__()
    • path
    • progress_callback
    • run()
    • checkout()
    • add()
    • auth()
    • blame()
    • cat()
    • changelist()
    • cleanup()
    • commit()
    • copy()
    • delete()
    • diff()
    • export()
    • help()
    • import_()
    • info()
    • ls()
    • lock()
    • log()
    • merge()
    • mkdir()
    • move()
    • patch()
    • propdel()
    • propedit()
    • propget()
    • proplist()
    • propset()
    • relocate()
    • resolve()
    • resolved()
    • revert()
    • status()
    • switch()
    • unlock()
    • update()
    • upgrade()