-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathindex.html
More file actions
293 lines (277 loc) · 10.8 KB
/
index.html
File metadata and controls
293 lines (277 loc) · 10.8 KB
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>soap — An app cleaner CLI for macOS</title>
<meta
name="description"
content="A macOS CLI that removes an app and all its leftover files — preferences, caches, containers, launch agents, and more."
/>
<link rel="stylesheet" href="./style.css" />
</head>
<body>
<nav id="nav">
<div class="nav-inner">
<a class="nav-logo" href="#">soap<span>🧼</span></a>
<ul class="nav-links">
<li><a href="#features">Features</a></li>
<li><a href="#quickstart">Quick Start</a></li>
<li><a href="#cli">CLI</a></li>
</ul>
<a
class="nav-cta"
href="https://github.com/kud/soap-cli"
target="_blank"
rel="noopener"
>GitHub ↗</a
>
</div>
</nav>
<main>
<section class="hero">
<div class="hero-bg"></div>
<div class="hero-grid"></div>
<div class="hero-content">
<div class="hero-badge">
<span class="hero-badge-dot"></span> __VERSION__ · MIT
</div>
<h1>🧽 soap</h1>
<p>
A macOS CLI that removes an app
<em>and all its leftover files</em> — preferences, caches,
containers, launch agents, and more.
</p>
<div class="hero-ctas">
<a
class="btn btn-primary"
href="https://www.npmjs.com/package/@kud/soap-cli"
target="_blank"
rel="noopener"
>View on npm</a
>
<a
class="btn btn-ghost"
href="https://github.com/kud/soap-cli"
target="_blank"
rel="noopener"
>GitHub ↗</a
>
</div>
<div class="hero-command code-block">
<code>npm install -g @kud/soap-cli</code>
<button class="copy-btn" data-copy="npm install -g @kud/soap-cli">
Copy
</button>
</div>
<div class="stats">
<div class="stat">
<span class="stat-value">__VERSION__</span>
<div class="stat-label">Latest</div>
</div>
<div class="stat-divider"></div>
<div class="stat">
<span class="stat-value">40+</span>
<div class="stat-label">Dirs Scanned</div>
</div>
<div class="stat-divider"></div>
<div class="stat">
<span class="stat-value">macOS</span>
<div class="stat-label">Platform</div>
</div>
<div class="stat-divider"></div>
<div class="stat">
<span class="stat-value">MIT</span>
<div class="stat-label">Licence</div>
</div>
</div>
</div>
</section>
<section id="features">
<div class="section-inner">
<span class="section-eyebrow reveal">Why soap</span>
<h2 class="reveal">Features</h2>
<p class="section-sub reveal">
Everything AppCleaner does, but open-source and terminal-native. No
GUI, no drag-and-drop — just a single command.
</p>
<div class="features-grid">
<div class="feature-card reveal">
<div class="feature-icon">🧹</div>
<div class="feature-title">Deep Directory Scan</div>
<div class="feature-desc">
Scans 40+ macOS locations including Application Support, Caches,
Containers, Preferences, LaunchAgents, and more — nothing gets
left behind.
</div>
</div>
<div class="feature-card reveal">
<div class="feature-icon">🍺</div>
<div class="feature-title">Homebrew Integration</div>
<div class="feature-desc">
Resolves app metadata from <code>brew info</code> and fetches
the cask's zap stanza — the maintainer-curated list of known
leftover paths.
</div>
</div>
<div class="feature-card reveal">
<div class="feature-icon">🗑️</div>
<div class="feature-title">Safe by Default</div>
<div class="feature-desc">
Files are moved to Trash, never permanently deleted. A full
checkbox list lets you deselect anything you want to keep before
anything moves.
</div>
</div>
<div class="feature-card reveal">
<div class="feature-icon">📁</div>
<div class="feature-title">Cask & Path Mode</div>
<div class="feature-desc">
Works with Homebrew cask names (<code>soap spotify</code>) or
direct app paths (<code>soap '/Applications/Spotify.app'</code>)
for manually installed apps.
</div>
</div>
<div class="feature-card reveal">
<div class="feature-icon">🔍</div>
<div class="feature-title">Bundle ID Awareness</div>
<div class="feature-desc">
Derives the bundle identifier from the app and also scans vendor
subdirectories (e.g. <code>com.spotify.client</code>) that a
simple name-match would miss.
</div>
</div>
<div class="feature-card reveal">
<div class="feature-icon">🐛</div>
<div class="feature-title">Debug Mode</div>
<div class="feature-desc">
Set <code>SOAP_DEBUG=1</code> to enable verbose subprocess
output and trace every command that runs under the hood.
</div>
</div>
</div>
</div>
</section>
<section id="quickstart">
<div class="section-inner">
<span class="section-eyebrow reveal">Get going fast</span>
<h2 class="reveal">Quick Start</h2>
<p class="section-sub reveal">
Install once, then pass any Homebrew cask name or app path. soap
handles the rest interactively.
</p>
<div class="code-block reveal">
<pre><code><span class="comment"># Install globally via npm</span>
<span class="cmd">npm install -g @kud/soap-cli</span>
<span class="comment"># Or via Homebrew</span>
<span class="cmd">brew install kud/tap/soap-cli</span>
<span class="comment"># Remove Spotify and all its leftover files</span>
<span class="cmd">soap spotify</span>
<span class="output">
Welcome to soap 🧼, the app cleaner.
⠋ Fetching cask info…
⠋ Scanning for files…
ℹ Cleaning: Spotify
ℹ Mode: cask (spotify)
? Found 11 files. Select what to move to Trash:
◉ /Users/kud/Library/Application Support/Spotify
◉ /Users/kud/Library/Caches/com.spotify.client
◉ /Users/kud/Library/Preferences/com.spotify.client.plist
◉ /Users/kud/Library/Saved Application State/com.spotify.client.savedState
◉ /Users/kud/Library/Logs/Spotify
? Run `brew uninstall --zap spotify`? Yes
✔ Moved 11 file(s) to Trash.
✔ Done.</span>
<span class="comment"># For a manually installed app (no cask)</span>
<span class="cmd">soap '/Applications/Android Studio.app'</span></code></pre>
<button class="copy-btn" data-copy="soap spotify">Copy</button>
</div>
</div>
</section>
<section id="cli">
<div class="section-inner">
<span class="section-eyebrow reveal">Commands</span>
<h2 class="reveal">CLI Reference</h2>
<p class="section-sub reveal">
The <code>soap</code> command accepts a Homebrew cask name, a direct
app path, or a flag.
</p>
<div class="cli-list reveal">
<div class="cli-row">
<span class="cli-cmd">soap <cask-name></span>
<span class="cli-desc"
>Clean an app installed via Homebrew cask. Resolves app info,
scans 40+ directories, fetches the zap stanza, and presents a
checkbox list before moving anything to Trash.</span
>
</div>
<div class="cli-row">
<span class="cli-cmd">soap <path-to-app></span>
<span class="cli-desc"
>Clean a manually installed .app bundle (e.g. from a DMG). Skips
the Homebrew step — scans by app name and bundle ID only.</span
>
</div>
<div class="cli-row">
<span class="cli-cmd">soap --help</span>
<span class="cli-desc"
>Show usage information and available options.</span
>
</div>
<div class="cli-row">
<span class="cli-cmd">SOAP_DEBUG=1 soap <name></span>
<span class="cli-desc"
>Enable verbose debug output — prints every subprocess command
that runs so you can trace exactly what soap is doing.</span
>
</div>
</div>
</div>
</section>
</main>
<footer>
<div class="footer-inner">
<span class="footer-name">@kud/soap-cli</span>
<nav class="footer-links">
<a href="https://github.com/kud/soap-cli">GitHub</a>
<a href="https://www.npmjs.com/package/@kud/soap-cli">npm</a>
<a href="https://github.com/kud/soap-cli/blob/main/CHANGELOG.md"
>Changelog</a
>
</nav>
<span class="footer-copy">MIT Licence</span>
</div>
</footer>
<script>
const nav = document.getElementById("nav")
const onScroll = () =>
nav.classList.toggle("scrolled", window.scrollY > 20)
window.addEventListener("scroll", onScroll, { passive: true })
onScroll()
document.querySelectorAll(".copy-btn").forEach((btn) => {
btn.addEventListener("click", () => {
const text =
btn.dataset.copy ||
btn.closest(".hero-command")?.querySelector("code")?.textContent ||
""
navigator.clipboard.writeText(text).then(() => {
btn.textContent = "Copied!"
btn.classList.add("copied")
setTimeout(() => {
btn.textContent = "Copy"
btn.classList.remove("copied")
}, 1800)
})
})
})
const observer = new IntersectionObserver(
(entries) =>
entries.forEach((e) => {
if (e.isIntersecting) e.target.classList.add("visible")
}),
{ threshold: 0.07, rootMargin: "0px 0px -40px 0px" },
)
document.querySelectorAll(".reveal").forEach((el) => observer.observe(el))
</script>
</body>
</html>