agentool 0.2.0

Rust toolkit for AI agents: JSON Schema-defined tools for workspace files, search, web, Markdown, Git, memory, human-in-the-loop hooks, and todos.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181

# Git (`git`)

[中文](README.zh.md) | English

[← Back to repository overview](../../README.md)

Sources: [mod.rs](mod.rs)

## `git_status`

Working tree status.

| Parameter | Type | Required | Notes |
|-----------|------|----------|--------|
| `path` | `string` | no | Repository path; default current directory |

**Returns**

| Field | Type |
|-------|------|
| `changes` | `Change[]` |
| `changes[].file` | `string` |
| `changes[].status` | `"added" \| "modified" \| "deleted" \| "untracked"` |

---

## `git_diff`

Show a textual diff.

| Parameter | Type | Required | Notes |
|-----------|------|----------|--------|
| `path` | `string` | no | Repo or file path; default cwd |
| `staged` | `boolean` | no | Staged diff; default `false` |

**Returns**

| Field | Type |
|-------|------|
| `diff` | `string` |

---

## `git_commit`

Stage and commit.

| Parameter | Type | Required | Notes |
|-----------|------|----------|--------|
| `message` | `string` | yes | Commit message |
| `files` | `string[]` | no | Stage only these paths; default all changes |

**Returns**

| Field | Type |
|-------|------|
| `hash` | `string` |
| `message` | `string` |

---

## `git_log`

Commit history.

| Parameter | Type | Required | Notes |
|-----------|------|----------|--------|
| `path` | `string` | no | Repo or file path; default cwd |
| `limit` | `number` | no | Default 10 |

**Returns**

| Field | Type |
|-------|------|
| `commits` | `Commit[]` |
| `commits[].hash` | `string` |
| `commits[].message` | `string` |
| `commits[].author` | `string` |
| `commits[].date` | `string` | ISO 8601 |

## Error codes

See [`error.rs`](error.rs).

| Code | Meaning |
|------|---------|
| `GIT_ERROR` | Not a repo, libgit2 failure, invalid state, etc. |

---

## `worktree_add`

Create a new linked worktree. If `branch` does not exist it is created from HEAD.

| Parameter | Type | Required | Notes |
|-----------|------|----------|--------|
| `name` | `string` | yes | Worktree name |
| `path` | `string` | yes | Directory path for the new worktree |
| `branch` | `string` | no | Branch to check out; created from HEAD if absent |
| `repo` | `string` | no | Repository path (default: context root) |

**Returns**

| Field | Type |
|-------|------|
| `name` | `string` |
| `path` | `string` |
| `branch` | `string` |

---

## `worktree_list`

List all linked worktrees with their path and lock status.

| Parameter | Type | Required | Notes |
|-----------|------|----------|--------|
| `repo` | `string` | no | Repository path (default: context root) |

**Returns**

| Field | Type |
|-------|------|
| `worktrees` | `Worktree[]` |
| `worktrees[].name` | `string` |
| `worktrees[].path` | `string` |
| `worktrees[].locked` | `boolean` |

---

## `worktree_remove`

Remove a linked worktree.

| Parameter | Type | Required | Notes |
|-----------|------|----------|--------|
| `name` | `string` | yes | Worktree name |
| `force` | `boolean` | no | Force removal even if the worktree is locked (default `false`) |
| `repo` | `string` | no | Repository path (default: context root) |

**Returns**

| Field | Type |
|-------|------|
| `name` | `string` |

---

## `worktree_lock`

Lock a worktree to prevent accidental removal.

| Parameter | Type | Required | Notes |
|-----------|------|----------|--------|
| `name` | `string` | yes | Worktree name |
| `reason` | `string` | no | Lock reason |
| `repo` | `string` | no | Repository path (default: context root) |

**Returns**

| Field | Type |
|-------|------|
| `name` | `string` |
| `reason` | `string` |

---

## `worktree_unlock`

Unlock a previously locked worktree.

| Parameter | Type | Required | Notes |
|-----------|------|----------|--------|
| `name` | `string` | yes | Worktree name |
| `repo` | `string` | no | Repository path (default: context root) |

**Returns**

| Field | Type |
|-------|------|
| `name` | `string` |