Update documentation 2026-01-05
This commit is contained in:
+122
-10
@@ -2,23 +2,135 @@
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>CmdForge Overview</title>
|
||||
<style>
|
||||
body { background: #1a1a2e; color: #eaeaea; font-family: sans-serif; padding: 2rem; line-height: 1.7; }
|
||||
:root {
|
||||
--bg: #1a1a2e;
|
||||
--surface: #16213e;
|
||||
--primary: #0f3460;
|
||||
--accent: #e94560;
|
||||
--text: #eaeaea;
|
||||
--text-muted: #a0a0a0;
|
||||
--code-bg: #0d1117;
|
||||
}
|
||||
* { margin: 0; padding: 0; box-sizing: border-box; }
|
||||
body {
|
||||
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
|
||||
background: var(--bg);
|
||||
color: var(--text);
|
||||
line-height: 1.7;
|
||||
padding: 2rem;
|
||||
}
|
||||
.container { max-width: 900px; margin: 0 auto; }
|
||||
a { color: #e94560; }
|
||||
h1, h2 { border-bottom: 1px solid #0f3460; padding-bottom: 0.3rem; }
|
||||
pre { background: #0d1117; padding: 1rem; border-radius: 8px; overflow-x: auto; }
|
||||
code { font-family: monospace; }
|
||||
table { width: 100%; border-collapse: collapse; margin: 1rem 0; }
|
||||
th, td { border: 1px solid #0f3460; padding: 0.75rem; text-align: left; }
|
||||
th { background: #16213e; }
|
||||
.back-link { display: inline-block; margin-bottom: 1rem; color: #a0a0a0; }
|
||||
a { color: var(--accent); }
|
||||
h1, h2, h3, h4 { margin: 1.5rem 0 1rem; color: var(--text); }
|
||||
h1 { font-size: 2rem; border-bottom: 2px solid var(--accent); padding-bottom: 0.5rem; }
|
||||
h2 { font-size: 1.5rem; border-bottom: 1px solid var(--primary); padding-bottom: 0.3rem; }
|
||||
h3 { font-size: 1.25rem; }
|
||||
p { margin: 1rem 0; }
|
||||
pre {
|
||||
background: var(--code-bg);
|
||||
padding: 1rem;
|
||||
border-radius: 8px;
|
||||
overflow-x: auto;
|
||||
margin: 1rem 0;
|
||||
}
|
||||
code {
|
||||
font-family: 'Fira Code', 'Consolas', 'Monaco', monospace;
|
||||
font-size: 0.9rem;
|
||||
}
|
||||
:not(pre) > code {
|
||||
background: var(--code-bg);
|
||||
padding: 0.2rem 0.4rem;
|
||||
border-radius: 4px;
|
||||
}
|
||||
table {
|
||||
width: 100%;
|
||||
border-collapse: collapse;
|
||||
margin: 1rem 0;
|
||||
}
|
||||
th, td {
|
||||
border: 1px solid var(--primary);
|
||||
padding: 0.75rem;
|
||||
text-align: left;
|
||||
}
|
||||
th { background: var(--surface); }
|
||||
.back-link {
|
||||
display: inline-block;
|
||||
margin-bottom: 1rem;
|
||||
color: var(--text-muted);
|
||||
text-decoration: none;
|
||||
}
|
||||
.back-link:hover { color: var(--accent); }
|
||||
ul, ol { margin: 1rem 0; padding-left: 2rem; }
|
||||
li { margin: 0.5rem 0; }
|
||||
strong { color: var(--text); }
|
||||
blockquote {
|
||||
border-left: 4px solid var(--accent);
|
||||
margin: 1rem 0;
|
||||
padding-left: 1rem;
|
||||
color: var(--text-muted);
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="container">
|
||||
<a href="index.html" class="back-link">← Back to Index</a>
|
||||
<article>
|
||||
<h1>CmdForge Overview</h1>
|
||||
<p>A lightweight personal tool builder for AI-powered CLI commands.</p>
|
||||
<h2>Project Links</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Resource</th>
|
||||
<th>URL</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr>
|
||||
<td><strong>Public Website</strong></td>
|
||||
<td><a href="https://cmdforge.brrd.tech/">https://cmdforge.brrd.tech/</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Git Repository</strong></td>
|
||||
<td><a href="https://gitea.brrd.tech/rob/CmdForge">https://gitea.brrd.tech/rob/CmdForge</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Registry Repo</strong></td>
|
||||
<td><a href="https://gitea.brrd.tech/rob/CmdForge-Registry">https://gitea.brrd.tech/rob/CmdForge-Registry</a></td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h2>Components</h2>
|
||||
<pre><code>┌─────────────────────────────────────────────────────────────┐
|
||||
│ CmdForge │
|
||||
├─────────────────┬─────────────────┬─────────────────────────┤
|
||||
│ CLI Tool │ Web UI │ Registry │
|
||||
│ (cmdforge) │ (Flask) │ (API + DB) │
|
||||
├─────────────────┼─────────────────┼─────────────────────────┤
|
||||
│ Local install │ cmdforge.brrd. │ Tool publishing │
|
||||
│ ~/.cmdforge/ │ tech │ Search, download │
|
||||
│ ~/.local/bin/ │ │ User accounts │
|
||||
└─────────────────┴─────────────────┴─────────────────────────┘
|
||||
</code></pre>
|
||||
<h2>Key Directories</h2>
|
||||
<h3>Development (AI-Server)</h3>
|
||||
<pre><code>~/PycharmProjects/CmdForge/ # Source code
|
||||
~/.cmdforge/ # Local tools storage
|
||||
~/.local/bin/cmdforge # CLI symlink
|
||||
</code></pre>
|
||||
<h3>Production (OpenMediaVault)</h3>
|
||||
<pre><code>/srv/mergerfs/data_pool/home/rob/cmdforge-registry/ # Deployed code
|
||||
/tmp/cmdforge-data/ # Runtime database
|
||||
</code></pre>
|
||||
<h2>Recent Changes</h2>
|
||||
<ul>
|
||||
<li><strong>2026-01-03</strong>: Migrated from SmartTools to CmdForge</li>
|
||||
<li><strong>2026-01-03</strong>: Added source field support for Fabric imports</li>
|
||||
<li><strong>2026-01-03</strong>: Created systemd service for web UI</li>
|
||||
</ul>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
</html>
|
||||
Reference in New Issue
Block a user