You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**One command to clone AI agent configurations into any project. One command to purge them.**
18
+
3
19
</div>
4
20
5
-
<br>
21
+
---
22
+
23
+
You have used AI coding assistants. You have copied `.opencode/`, `.flowr/`, `AGENTS.md`, and `.templates/` into projects by hand — or asked your team to do the same, over and over, across every repository. Files drift out of sync. Versions scatter. Onboarding a new repo means ten minutes of manual file wrangling before the first prompt.
6
24
7
-
<palign="center">
8
-
<strong>Clone AI agent configurations into any project.</strong><br>
9
-
<code>smith clone</code> fetches AGENTS.md, .opencode/, .flowr/, .templates/ from any source.<br>
10
-
<code>smith purge</code> removes them cleanly. No leftovers.
11
-
</p>
25
+
**smith enters a project, copies its patterns, and returns something more capable than what it found.**
Two commands. No configuration files in your project. No framework overhead. No leftover files after removal.
18
28
19
29
---
20
30
21
-
## Install
31
+
## Who is this for?
22
32
23
-
```bash
24
-
pip install agents-smith
25
-
```
33
+
### Developers — Stop copying AI config files between projects
26
34
27
-
## Quick start
35
+
You set up opencode, flowr, and agent templates in one project. Then you do it again. And again. `smith clone` pulls the exact same configuration from any GitHub repo, local directory, or URL into your project in one step. `smith purge` removes every file and every gitignore entry — no orphans, no stale references.
28
36
29
-
```bash
30
-
# Clone the default template (temple8) into your project
31
-
smith clone
37
+
### Teams — Consistent agent configurations across every repository
38
+
39
+
Every team member runs the same `smith clone` command and gets the same AGENTS.md, the same .opencode agents, the same .flowr workflows. No "it works on my machine." When the template updates, clone again with `--overwrite`. When a project no longer needs agentic tooling, `smith purge` and move on.
40
+
41
+
---
32
42
33
-
# Purge all smith-managed files when you're done
34
-
smith purge
43
+
## What it does
44
+
45
+
```
46
+
smith clone → fetches AGENTS.md, .opencode/, .flowr/, .templates/ into your project
47
+
smith purge → removes every smith-managed file and directory
35
48
```
36
49
37
-
That's it. AGENTS.md, .opencode/, .flowr/, and .templates/ appear in your project, tracked in .gitignore. When you're done, `smith purge` removes every file and directory — no orphan files, no stale .gitignore entries.
50
+
**Safety boundary.** Only files matching allowed topics are ever written — regardless of what the source archive contains. Your project never receives arbitrary files.
38
51
39
-
## Source resolution
52
+
**Clean removal.** Purge reads the managed section in `.gitignore` and deletes exactly what is listed there. The section itself is preserved so you can clone again later.
53
+
54
+
**Source resolution.** Three ways to specify where templates come from:
40
55
41
56
| Priority | Source | Example |
42
57
|----------|--------|---------|
43
58
| 1 — CLI flag |`--source`|`smith clone --source github:myorg/templates`|
| 3 — Default |`github:nullhack/temple8`| Used when no flag or config is set |
46
61
62
+
---
63
+
64
+
## Quick start
65
+
66
+
```bash
67
+
pip install agents-smith
68
+
smith clone # default source (temple8)
69
+
smith purge # remove everything
70
+
```
71
+
72
+
That is it. Two commands. No setup, no config file, no framework.
73
+
74
+
---
75
+
47
76
## Commands
48
77
49
78
### `smith clone`
50
79
51
-
Fetches template files from a source, filters them by allowed topics, writes them to the project directory, and adds a managed section to .gitignore.
52
-
53
80
```bash
54
81
smith clone # default source
55
82
smith clone --source github:myorg/templates # GitHub shorthand
56
-
smith clone --source /path/to/local/template # local directory
57
-
smith clone --source https://example.com/t.zip # URL to archive
58
-
smith clone --overwrite # replace existing files
83
+
smith clone --source /path/to/local/template # local directory
84
+
smith clone --source https://example.com/t.zip # URL to archive
85
+
smith clone --overwrite # replace existing files
59
86
```
60
87
61
-
**Safety:** Only files matching allowed topics (AGENTS.md, .opencode/, .flowr/, .templates/) are ever written. Existing files and directories are skipped unless `--overwrite` is passed.
88
+
Fetches template files from a source, filters by allowed topics, writes them to the project directory, and adds a managed section to `.gitignore`. Existing files are skipped unless `--overwrite` is passed.
62
89
63
90
### `smith purge`
64
91
65
-
Reads the smith-managed section in .gitignore and deletes every file and directory listed there. The .gitignore section itself is preserved so you can clone again later.
66
-
67
92
```bash
68
93
smith purge # removes all smith-managed files
69
94
```
70
95
96
+
Reads the smith-managed section in `.gitignore` and deletes every file and directory listed there. The `.gitignore` section itself is preserved so you can clone again later.
97
+
98
+
---
99
+
71
100
## .gitignore section
72
101
73
102
```gitignore
@@ -81,6 +110,8 @@ AGENTS.md
81
110
82
111
Only items in this section are removed on purge. Edit it to control what smith manages.
Flat module structure. Two commands. No framework overhead. The allowed-topics list is a compile-time safety boundary — only agentic configuration files are ever written to your project, regardless of what the source archive contains.
124
+
Flat module structure. Two commands. No framework overhead.
0 commit comments