- Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathquickstart.html
More file actions
Latest commit
303 lines (269 loc) · 16.8 KB
/
Copy pathquickstart.html
File metadata and controls
303 lines (269 loc) · 16.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
294
295
296
297
298
299
300
301
302
<!DOCTYPE html>
<htmllang="en">
<head>
<metacharset="UTF-8">
<metaname="viewport" content="width=device-width, initial-scale=1.0">
<title>Getting Started — DevForge CLI Tools in 5 Minutes</title>
<metaname="description" content="Install your first DevForge CLI tool in under 5 minutes. Step-by-step guide: install, configure, run your first check, and integrate with CI/CD. No credit card required.">
<metaname="keywords" content="getting started, quickstart, CLI tools, install, setup, developer tools, first run, CI integration">
<metaproperty="og:title" content="Getting Started — DevForge CLI Tools in 5 Minutes">
<metaproperty="og:description" content="Install, configure, and run your first check in under 5 minutes. Free tier, no credit card.">
<metaproperty="og:type" content="website">
<metaproperty="og:url" content="https://coding-dev-tools.github.io/devforge/quickstart.html">
<metaname="twitter:site" content="@DevForge">
<metaname="twitter:card" content="summary_large_image">
<metaname="twitter:title" content="Getting Started — DevForge in 5 Min">
<metaname="twitter:description" content="Install, run your first check, and hook up CI in under 5 minutes.">
<metaname="twitter:image" content="https://coding-dev-tools.github.io/devforge/og-image.svg">
<metaproperty="og:image" content="https://coding-dev-tools.github.io/devforge/og-image.svg">
<metaproperty="og:image:width" content="1200">
<metaproperty="og:image:height" content="630">
<linkrel="canonical" href="https://coding-dev-tools.github.io/devforge/quickstart.html">
<linkrel="icon" href="data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100'><text y='.9em' font-size='90'>⚒</text></svg>">
<linkhref="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700;800&display=swap" rel="stylesheet">
<scripttype="application/ld+json">
{
"@context": "https://schema.org",
"@type": "HowTo",
"name": "Get Started with DevForge CLI Tools",
"description": "Install and run your first CLI tool check in under 5 minutes",
"totalTime": "PT5M",
"step": [
{"@type": "HowToStep","name": "Install API Contract Guardian","text": "pip install git+https://github.com/Coding-Dev-Tools/api-contract-guardian.git"},
{"@type": "HowToStep","name": "Run your first check","text": "acg validate openapi.yaml"},
{"@type": "HowToStep","name": "Add to CI","text": "Add acg validate to your GitHub Actions workflow"}
],
"isPartOf": {
"@type": "WebSite",
"name": "DevForge",
"url": "https://coding-dev-tools.github.io/devforge/"
}
}
</script>
<style>
*,*::before,*::after { box-sizing: border-box; margin:0; padding:0; }
body { font-family:'Inter', -apple-system, sans-serif; background:#0a0a0b; color:#e1e1e3; line-height:1.6; min-height:100vh; }
/* Navigation */
nav { position: fixed; top:0; width:100%; z-index:100; background:rgba(10,10,11,0.85); backdrop-filter:blur(12px); border-bottom:1px solid #1e1e20; }
nav .inner { max-width:1100px; margin:0 auto; padding:14px24px; display: flex; align-items: center; justify-content: space-between; }
nav .logo { font-weight:700; font-size:1.15rem; color:#fff; letter-spacing:-0.02em; }
nav .logospan { color:#6366f1; }
nav .linksa { color:#888; text-decoration: none; font-size:0.85rem; margin-left:28px; transition: color .15s; }
nav .linksa:hover { color:#fff; }
nav .linksa.active { color:#fff; }
/* Hero */
.hero { max-width:1100px; margin:0 auto; padding:140px24px48px; text-align: center; }
.heroh1 { font-size:2.6rem; font-weight:800; line-height:1.15; letter-spacing:-0.04em; color:#fff; }
.heroh1span { background:linear-gradient(135deg,#6366f1,#a78bfa); -webkit-background-clip: text; -webkit-text-fill-color: transparent; }
.herop { font-size:1.05rem; color:#888; max-width:550px; margin:16px auto 0; }
.hero .timer { display: inline-flex; align-items: center; gap:6px; margin-top:16px; padding:6px16px; background:rgba(99,102,241,0.1); border:1px solid rgba(99,102,241,0.25); border-radius:20px; font-size:0.8rem; color:#a78bfa; font-weight:600; }
/* Steps */
.steps { max-width:780px; margin:0 auto; padding:024px100px; }
.step { margin-bottom:56px; position: relative; }
.step-number { display: inline-flex; align-items: center; justify-content: center; width:36px; height:36px; border-radius:10px; background:#6366f1; color:#fff; font-weight:700; font-size:0.95rem; margin-bottom:16px; }
.steph2 { font-size:1.4rem; font-weight:700; color:#fff; margin-bottom:8px; letter-spacing:-0.02em; }
.stepp { font-size:0.9rem; color:#aaa; margin-bottom:16px; max-width:600px; }
.code-block { background:#121213; border:1px solid #1e1e20; border-radius:10px; overflow: hidden; margin-bottom:16px; }
.code-block .header { display: flex; justify-content: space-between; align-items: center; padding:10px16px; background:#161617; border-bottom:1px solid #1e1e20; }
.code-block .headerspan { font-size:0.72rem; color:#666; font-weight:600; text-transform: uppercase; letter-spacing:0.5px; }
.code-blockpre { padding:16px; margin:0; overflow-x: auto; }
.code-blockcode { font-family:'SF Mono','Fira Code', monospace; font-size:0.82rem; color:#c4c4cc; line-height:1.6; }
.code-block .comment { color:#555; }
.code-block .cmd { color:#34d399; }
.code-block .flag { color:#6366f1; }
.code-block .string { color:#f59e0b; }
.output-block { background:#0d0d0e; border:1px solid #1a1a1d; border-radius:10px; padding:16px; margin-bottom:16px; }
.output-block .label { font-size:0.7rem; text-transform: uppercase; color:#555; letter-spacing:0.5px; font-weight:600; margin-bottom:8px; }
.output-blockpre { margin:0; font-family:'SF Mono','Fira Code', monospace; font-size:0.78rem; color:#888; line-height:1.6; }
.output-block .pass { color:#34d399; }
.output-block .fail { color:#ef4444; }
.output-block .warn { color:#f59e0b; }
.callout { background:rgba(99,102,241,0.06); border:1px solid rgba(99,102,241,0.15); border-radius:10px; padding:16px20px; margin-bottom:16px; }
.calloutp { font-size:0.82rem; color:#a78bfa; margin:0; }
.calloutpstrong { color:#c4b5fd; }
/* Tool picker */
.tool-picker { display: flex; flex-wrap: wrap; gap:10px; margin-bottom:24px; }
.tool-pickera { display: flex; align-items: center; gap:8px; padding:10px18px; background:#121213; border:1px solid #1e1e20; border-radius:10px; color:#aaa; text-decoration: none; font-size:0.82rem; font-weight:500; transition: all .15s; }
.tool-pickera:hover { border-color:#6366f1; color:#fff; }
.tool-pickera .icon { font-size:1rem; }
/* Next links */
.next-steps { background:#121213; border:1px solid #1e1e20; border-radius:14px; padding:32px; margin-top:32px; }
.next-stepsh3 { font-size:1.1rem; font-weight:700; color:#fff; margin-bottom:16px; }
.next-stepsa { display: block; padding:12px0; border-bottom:1px solid #1a1a1d; color:#a78bfa; text-decoration: none; font-size:0.88rem; font-weight:500; transition: color .15s; }
.next-stepsa:last-child { border-bottom: none; }
.next-stepsa:hover { color:#fff; }
.next-stepsa .arrow { margin-left:6px; transition: transform .15s; }
.next-stepsa:hover .arrow { transform:translateX(4px); }
/* Footer */
footer { max-width:1100px; margin:0 auto; padding:40px24px; border-top:1px solid #1e1e20; display: flex; justify-content: space-between; align-items: center; flex-wrap: wrap; gap:12px; }
footerspan { font-size:0.8rem; color:#555; }
footera { color:#888; text-decoration: none; font-size:0.8rem; }
footera:hover { color:#fff; }
@media (max-width:640px) {
.heroh1 { font-size:1.8rem; }
nav .linksa { margin-left:12px; font-size:0.75rem; }
.code-blockcode { font-size:0.72rem; }
}
</style>
<!-- Plausible Analytics -->
<scriptdeferdata-domain="devforge" src="https://plausible.io/js/script.js"></script>
</head>
<body>
<nav>
<divclass="inner">
<divclass="logo"><ahref=""><span>⚒</span> DevForge</a></div>
<divclass="links">
<ahref="start-here.html">Start Here</a>
<ahref="quickstart.html" style="font-weight:700">Get Started</a>
<ahref="#products">Products</a>
<ahref="docs.html">Docs</a>
<ahref="pricing.html">Pricing</a>
<ahref="alternatives.html">Alternatives</a>
<ahref="releases.html">Changelog</a>
<ahref="blog.html">Blog</a>
<ahref="about.html">About</a>
<ahref="https://github.com/Coding-Dev-Tools" target="_blank">GitHub</a>
</div>
</div>
</nav>
<sectionclass="hero">
<h1>Get Started in <span>5 Minutes</span></h1>
<p>Install a tool, run your first check, and hook it into CI. Free tier, no credit card, no signup.</p>
<divclass="timer">⚡ Under 5 minutes from zero to first check</div>
</section>
<divclass="steps">
<!-- Step 1: Choose a tool -->
<divclass="step">
<divclass="step-number">1</div>
<h2>Pick your tool</h2>
<p>Every tool installs standalone. Pick the one that solves your immediate problem — or install the full suite.</p>
<divclass="tool-picker">
<ahref="#install-acg"><spanclass="icon">⚡</span> API Contract Guardian</a>
<ahref="#install-j2s"><spanclass="icon">🗃️</span> json2sql</a>
<ahref="#install-dd"><spanclass="icon">☁️</span> DeployDiff</a>
<ahref="#install-cd"><spanclass="icon">⌘</span> ConfigDrift</a>
<ahref="#install-aa"><spanclass="icon">🔑</span> APIAuth</a>
<ahref="#install-ag"><spanclass="icon">👻</span> APIGhost</a>
<ahref="#install-ev"><spanclass="icon">🛡️</span> Envault</a>
<ahref="#install-sf"><spanclass="icon">🔄</span> SchemaForge</a>
<ahref="#install-ctm"><spanclass="icon">🔌</span> click-to-mcp</a>
<ahref="#install-dm"><spanclass="icon">🔄</span> DataMorph</a>
<ahref="#install-dc"><spanclass="icon">🧹</span> DeadCode</a>
</div>
<divclass="callout">
<p><strong>Want all 11?</strong><codestyle="color:#34d399;background:rgba(16,185,129,0.1);padding:2px 8px;border-radius:4px;">pip install git+https://github.com/Coding-Dev-Tools/devforge.git</code> installs the entire suite. Use the <codestyle="color:#f59e0b;">git+https</code> install method shown below — no account or token needed.</p>
</div>
</div>
<!-- Step 2: Install -->
<divclass="step" id="install-acg">
<divclass="step-number">2</div>
<h2>Install</h2>
<p>One command. Python 3.9+ required. Virtual environment recommended.</p>
<divclass="callout">
<p><strong>Install via GitHub.</strong> All tools install via <code>pip install git+https://...</code> — no signup, no token required. Also available via npm, Homebrew, and Scoop.</p>
</div>
<divclass="code-block">
<divclass="header"><span>Terminal</span></div>
<pre><code><spanclass="comment"># Create a venv (optional but recommended)</span>
<spanclass="cmd">python -m venv .venv && source .venv/bin/activate</span>
<spanclass="comment"># Install the full suite (all 11 tools, one command)</span>
<spanclass="cmd">pip install git+https://github.com/Coding-Dev-Tools/devforge.git</span>
<spanclass="comment"># Or install individual tools</span>
<spanclass="cmd">pip install git+https://github.com/Coding-Dev-Tools/api-contract-guardian.git</span>
<spanclass="cmd">pip install git+https://github.com/Coding-Dev-Tools/json2sql.git</span>
<spanclass="cmd">pip install git+https://github.com/Coding-Dev-Tools/deploydiff.git</span>
<spanclass="cmd">pip install git+https://github.com/Coding-Dev-Tools/configdrift.git</span>
<spanclass="cmd">pip install git+https://github.com/Coding-Dev-Tools/datamorph.git</span>
<spanclass="cmd">pip install git+https://github.com/Coding-Dev-Tools/apiauth.git</span>
<spanclass="cmd">pip install git+https://github.com/Coding-Dev-Tools/apighost.git</span>
<spanclass="cmd">pip install git+https://github.com/Coding-Dev-Tools/envault.git</span>
<spanclass="cmd">pip install git+https://github.com/Coding-Dev-Tools/schemaforge.git</span>
<spanclass="cmd">pip install git+https://github.com/Coding-Dev-Tools/click-to-mcp.git</span>
<spanclass="cmd">pip install git+https://github.com/Coding-Dev-Tools/deadcode.git</span></code></pre>
</div>
<pstyle="color:#888;font-size:0.82rem;">All tools are Apache 2.0 open source. Free tier works out of the box. Set <code>DEVFORGE_LICENSE_KEY</code> for unlimited pro access.</p>
</div>
<!-- Step 3: Run your first check -->
<divclass="step">
<divclass="step-number">3</div>
<h2>Run your first check</h2>
<p>Each tool works out of the box. Here are the most common first commands:</p>
<divclass="code-block">
<divclass="header"><span>API Contract Guardian</span></div>
<pre><code><spanclass="comment"># Validate an OpenAPI spec against a baseline</span>
<spanclass="cmd">acg validate</span> openapi.yaml <spanclass="flag">--baseline</span> openapi-base.yaml
<spanclass="comment"># Extract breaking changes between branches</span>
<spanclass="cmd">acg diff</span> main..feature/new-endpoint</code></pre>
</div>
<divclass="output-block">
<divclass="label">Output</div>
<pre>Validating openapi.yaml against baseline...
<spanclass="pass">✔ No breaking changes detected</span>
<spanclass="warn">⚠ 2 compatible additions found:</span>
- POST /api/v2/users (added endpoint)
- User.email (added property)</pre>
</div>
<divclass="code-block">
<divclass="header"><span>json2sql</span></div>
<pre><code><spanclass="comment"># Convert a JSON file to SQL INSERT statements</span>
<spanclass="cmd">json2sql</span> users.json <spanclass="flag">--dialect</span> postgresql <spanclass="flag">--output</span> users.sql</code></pre>
</div>
<divclass="code-block">
<divclass="header"><span>DeployDiff</span></div>
<pre><code><spanclass="comment"># Preview infrastructure changes</span>
<spanclass="cmd">deploydiff</span> docker-compose.yml <spanclass="flag">--compare</span> docker-compose.prod.yml</code></pre>
</div>
<divclass="code-block">
<divclass="header"><span>DeadCode</span></div>
<pre><code><spanclass="comment"># Scan for unused exports in a TypeScript project</span>
<spanclass="cmd">deadcode scan</span><spanclass="flag">-p</span> /path/to/ts-project</code></pre>
</div>
</div>
<!-- Step 4: Add to CI -->
<divclass="step">
<divclass="step-number">4</div>
<h2>Add to CI/CD</h2>
<p>Every tool returns exit code 1 on failure. Drop them into any CI pipeline.</p>
<divclass="code-block">
<divclass="header"><span>GitHub Actions</span></div>
<pre><code><spanclass="comment"># .github/workflows/api-contracts.yml</span>
<spanclass="cmd">name:</span> API Contract Check
<spanclass="cmd">on:</span> [pull_request]
<spanclass="cmd">jobs:</span>
<spanclass="cmd">contracts:</span>
<spanclass="cmd">runs-on:</span> ubuntu-latest
<spanclass="cmd">steps:</span>
- <spanclass="cmd">uses:</span> actions/checkout@v4
<spanclass="cmd">with:</span> { fetch-depth: 0 }
- <spanclass="cmd">run:</span> pip install git+https://github.com/Coding-Dev-Tools/api-contract-guardian.git
- <spanclass="cmd">run:</span> acg validate openapi.yaml --baseline origin/main</code></pre>
</div>
<divclass="callout">
<p><strong>Free tier works in CI.</strong> All tools run locally and in CI on the free tier. Rate limits only apply to heavy batch operations. See <ahref="pricing.html" style="color:#a78bfa;">pricing</a> for details.</p>
</div>
</div>
<!-- Step 5: Explore more -->
<divclass="step">
<divclass="step-number">5</div>
<h2>Explore the rest</h2>
<p>Once you've got one tool running, the others follow the same pattern — install, run, add to CI.</p>
<divclass="next-steps">
<h3>Where to go next</h3>
<ahref="docs.html">Full documentation for all 11 tools <spanclass="arrow">→</span></a>
<ahref="alternatives.html">Compare with alternatives (Spectral, Oasdiff, knip, etc.) <spanclass="arrow">→</span></a>
<ahref="pricing.html">Pricing — per-tool or suite bundle <spanclass="arrow">→</span></a>
<ahref="blog.html">Blog — tutorials, comparisons, and deep dives <spanclass="arrow">→</span></a>
<ahref="https://github.com/Coding-Dev-Tools" target="_blank">GitHub — all repos, issues, and releases <spanclass="arrow">→</span></a>
</div>
</div>
</div>
<footer>
<span>© 2026 DevForge. Open-source developer tools.</span>
<ahref="">Home</a>
<ahref="pricing.html">Pricing</a>
<ahref="docs.html">Docs</a>
<ahref="blog.html">Blog</a>
<ahref="https://github.com/Coding-Dev-Tools" target="_blank">GitHub</a>
</footer>
</body>
</html>