Git component

The git component runs structured version-control operations - status, diff, log, show, branch, remote, add, commit, checkout, init, clone, push, pull - and returns parsed results (file lists, commit objects, branch lists) instead of raw command output. It is a kdeps component (YAML, no Go code) from the components asset set: call it with a component: resource, no install step. Its operations are the kdeps API's git_ops tool; the component only POSTs the arguments.

Where it runs

Both workflow mode and agent mode. In agent mode, the workflow containing it runs as a single callable tool.

Requirements

git on PATH. The operations are served by the kdeps API's git_ops tool in the kdeps process; the component makes one call and returns the result.

Basic usage

# resources/status.yaml
actionId: gitStatus
name: Check Repository Status
component:
  name: git                    # from the components asset set; a components/git/ of your own wins
  with:
    operation: status
    workingDir: /path/to/repo  # default: the current directory

# resources/commit.yaml
actionId: gitCommit
name: Commit Changes
requires: [gitStatus]
component:
  name: git
  with:
    operation: commit
    workingDir: /path/to/repo
    message: "feat: add new feature"
    dryRun: true               # report what would happen, change nothing

Inputs

Input	Operation	Description
operation	all	status, diff, log, show, branch, remote, add, commit, checkout, init, clone, push, pull (required)
workingDir	all	Repository directory; for clone, the target directory
paths	add, checkout, diff, log	Space-separated paths (add defaults to .)
message	commit	Commit message (required for commit)
branch	checkout, push, pull	Branch name
url	clone	Repository URL
remote	push, pull	Remote name (default origin)
args	show	Extra space-separated git arguments, e.g. HEAD~1
maxCount	log	Commits to list (default 10)
dryRun	add, commit, checkout, init, clone, push, pull	Preview without modifying

Component inputs are passed as strings, so paths and args are space-separated (quote a path with spaces, shell-style: paths: "'my file.txt' src/").

Output

Every result has success: true plus the operation's fields; a failing git command fails the resource with git's error.

{"success": true, "branch": "main", "staged": ["file1.go"], "unstaged": ["file2.go"], "untracked": ["new.txt"], "conflicts": []}

Operation	Fields
status	branch, staged, unstaged, untracked, conflicts
diff	diff, additions, deletions
log	commits (hash, author, email, date, message), count
show	output
branch	branches (name, current, remote), current, count
remote	remotes (name, url, type), count
add / commit / checkout / init / clone / push / pull	staged / committed+message / switched+branch+paths / initialized+path / cloned+url / pushed or pulled+remote+branch; dryRun: true when previewing

# resources/report.yaml
requires: [gitStatus]
apiResponse:
  success: true
  response:
    branch: "{{ output('gitStatus').branch }}"
    untracked: "{{ output('gitStatus').untracked }}"

Best practices

1. Always set workingDir - avoid ambiguity about which repository is being operated on
2. Use dryRun on write operations - verify before committing, pushing, or checking out
3. Use status before add to understand what will be staged
4. Set maxCount on log to keep output bounded

How it is built

component: git -> POST /apis/tools.kdeps.io/v1/tools/git_ops/call -> {success, ...operation fields}

One httpClient POST carrying the ten inputs to the git_ops tool, then an interface.output that decodes the tool's JSON body. The tool runs git with GIT_PAGER=cat and GIT_TERMINAL_PROMPT=0 and parses the output into the same fields; a failing command returns git <operation> failed: exit status N with git's stderr. Copy components/git/ into your project to change an input default; the operations themselves live in the kdeps API.

See also

• Component resource - how component: calls pass with: inputs
• exec component - shell commands (use for other CLI tools)
• Git component source - the component and its tool asset