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
# Clone — downloads templates from the default source (temple8)
30
+
# Clone the default template (temple8) into your project
15
31
smith clone
16
32
17
-
# Clone from a specific source
18
-
smith clone --source github:myorg/my-template
19
-
smith clone --source /path/to/local/template
20
-
smith clone --source https://example.com/template.zip
21
-
22
-
# Clone and overwrite existing files
23
-
smith clone --overwrite
24
-
25
-
# Purge — removes files listed in the smith-managed .gitignore section
33
+
# Purge all smith-managed files when you're done
26
34
smith purge
27
35
```
28
36
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.
38
+
29
39
## Source resolution
30
40
31
-
1.`--source` CLI flag (highest priority)
32
-
2.`[tool.smith] source = "..."` in pyproject.toml
33
-
3. Default: `github:nullhack/temple8`
41
+
| Priority | Source | Example |
42
+
|----------|--------|---------|
43
+
| 1 — CLI flag |`--source`|`smith clone --source github:myorg/templates`|
| 3 — Default |`github:nullhack/temple8`| Used when no flag or config is set |
34
46
35
-
## How it works
47
+
## Commands
36
48
37
-
**clone**: Downloads AGENTS.md, .opencode/, .flowr/, .templates/ from the source. Skips any file or directory that already exists unless `--overwrite` is set. Adds a `# smith managed` section to .gitignore listing what was written.
49
+
### `smith clone`
38
50
39
-
**purge**: Reads the smith-managed section in .gitignore and deletes every file/directory listed there. Does not remove the .gitignore section itself.
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.
40
52
41
-
## .gitignore section
53
+
```bash
54
+
smith clone # default source
55
+
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
59
+
```
60
+
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.
62
+
63
+
### `smith purge`
64
+
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.
42
66
67
+
```bash
68
+
smith purge # removes all smith-managed files
43
69
```
70
+
71
+
## .gitignore section
72
+
73
+
```gitignore
44
74
# smith managed
45
75
AGENTS.md
46
76
.opencode/
@@ -49,4 +79,19 @@ AGENTS.md
49
79
# end smith managed
50
80
```
51
81
52
-
Only items listed in this section are deleted on purge. Edit this section to control what smith manages.
82
+
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.
Copy file name to clipboardExpand all lines: docs/branding/branding.md
+30-4Lines changed: 30 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Agents read this file before generating release names, C4 diagrams, README banne
11
11
## Identity
12
12
13
13
-**Project name:** agents-smith
14
-
-**Tagline:**Connect AI agent configurations to any project
14
+
-**Tagline:**Clone AI agent configurations into any project
15
15
-**Mission:** Eliminate the repetitive, error-prone process of manually copying AI agent configuration files into projects by providing a single command to fetch, install, and track them — then cleanly purge when done.
16
16
-**Vision:** Every developer can add or remove agentic tooling from any project with one command, confident that nothing is left behind or accidentally overwritten. Like Agent Smith in the Matrix, smith enters a project, copies its patterns, and returns something more capable than what it found.
17
17
-**Tone of voice:** direct, precise, minimal
@@ -40,9 +40,35 @@ Dark void background (`#0F1117`) with the S logo mark scaled to height, followed
0 commit comments