Spaces:
Running
Running
File size: 7,362 Bytes
54ab5cc 01dbee9 54ab5cc 01dbee9 54ab5cc 01dbee9 54ab5cc 01dbee9 54ab5cc 01dbee9 54ab5cc 01dbee9 54ab5cc 01dbee9 54ab5cc 01dbee9 54ab5cc 01dbee9 e0eef54 54ab5cc 01dbee9 e0eef54 01dbee9 54ab5cc 01dbee9 54ab5cc 01dbee9 54ab5cc 01dbee9 54ab5cc 01dbee9 54ab5cc 01dbee9 54ab5cc 01dbee9 54ab5cc e0eef54 01dbee9 54ab5cc 01dbee9 54ab5cc 01dbee9 e0eef54 01dbee9 54ab5cc 01dbee9 f2a44d1 01dbee9 e0eef54 01dbee9 54ab5cc 01dbee9 54ab5cc 01dbee9 54ab5cc 01dbee9 54ab5cc | 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 | <!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="GoalOS by AbteeX AI Labs documentation hub.">
<meta name="theme-color" content="#0b0d12">
<meta name="color-scheme" content="dark">
<title>GoalOS Docs</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@400;500;600&family=IBM+Plex+Sans:wght@400;500;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="../assets/styles.css">
</head>
<body>
<a class="skip-link" href="#main">Skip to content</a>
<header class="site-header">
<div class="shell header-row">
<a class="brand" href="../index.html">
<span class="brand-mark" aria-hidden="true"></span>
<span>
<strong>GoalOS</strong>
<span>by AbteeX AI Labs</span>
</span>
</a>
<nav class="site-nav" aria-label="Docs navigation">
<a href="../index.html">Home</a>
<a href="#quickstart">Quickstart</a>
<a href="#surfaces">Surfaces</a>
<a href="#publish">Publish</a>
</nav>
</div>
</header>
<main id="main" class="shell page page-docs">
<section class="section">
<p class="eyebrow">Docs</p>
<h1 class="page-title">GoalOS quick reference</h1>
<p class="lede">
Install commands, package summary, a minimal MCP configuration, and the publish path used for this Space.
</p>
</section>
<section id="quickstart" class="section">
<div class="section-head">
<h2>Quickstart</h2>
<p>Start with the package you need.</p>
</div>
<div class="card-grid">
<article class="card">
<div class="card-top">
<span>TypeScript</span>
<button class="button button-small" type="button" data-copy="npm install @goalos/core">Copy</button>
</div>
<pre><code>npm install @goalos/core</code></pre>
</article>
<article class="card">
<div class="card-top">
<span>Python</span>
<button class="button button-small" type="button" data-copy="pip install goalos">Copy</button>
</div>
<pre><code>pip install goalos</code></pre>
</article>
<article class="card">
<div class="card-top">
<span>CLI</span>
<button class="button button-small" type="button" data-copy="npm install -g goalos">Copy</button>
</div>
<pre><code>npm install -g goalos</code></pre>
</article>
<article class="card">
<div class="card-top">
<span>MCP</span>
<button class="button button-small" type="button" data-copy="npm install -g @goalos/mcp-server">Copy</button>
</div>
<pre><code>npm install -g @goalos/mcp-server</code></pre>
</article>
</div>
</section>
<section id="surfaces" class="section">
<div class="section-head">
<h2>Package surfaces</h2>
<p>Packages are separated by runtime and integration surface.</p>
</div>
<div class="table-panel">
<table class="info-table">
<thead>
<tr>
<th>Surface</th>
<th>Use</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>@goalos/core</code></td>
<td>Core graph operations in TypeScript.</td>
</tr>
<tr>
<td><code>goalos</code> CLI</td>
<td>Local graph creation, status, export, validation, and serving.</td>
</tr>
<tr>
<td><code>@goalos/mcp-server</code></td>
<td>MCP access for clients such as Claude Desktop.</td>
</tr>
<tr>
<td><code>goalos</code> Python</td>
<td>Python graph modeling and automation workflows.</td>
</tr>
</tbody>
</table>
</div>
</section>
<section class="section">
<div class="section-head">
<h2>MCP example</h2>
<p>Minimal client configuration.</p>
</div>
<article class="panel panel-code">
<div class="panel-head">
<span>mcpServers</span>
<button class="button button-small" type="button" data-copy-source="mcp-example">Copy</button>
</div>
<pre><code id="mcp-example">{
"mcpServers": {
"goalos": {
"command": "npx",
"args": ["@goalos/mcp-server"]
}
}
}</code></pre>
</article>
</section>
<section id="publish" class="section">
<div class="section-head">
<h2>Publish this Space</h2>
<p>Commands used to verify and publish this Space from this repo.</p>
</div>
<article class="panel panel-code">
<div class="panel-head">
<span>Deploy commands</span>
<button class="button button-small" type="button" data-copy-source="publish-example">Copy</button>
</div>
<pre><code id="publish-example">node scripts/verify-hf-space.mjs
node scripts/publish-hf-space.mjs</code></pre>
</article>
</section>
<section class="section">
<div class="section-head">
<h2>Links</h2>
<p>GitHub contains the full repository, examples, and spec files.</p>
</div>
<div class="link-grid">
<a class="link-card" href="https://github.com/Aimaghsoodi/GoalOS" target="_blank" rel="noopener noreferrer">
<strong>GitHub repository</strong>
<span>Source, issues, releases, and package docs.</span>
</a>
<a class="link-card" href="https://github.com/Aimaghsoodi/GoalOS/tree/main/spec" target="_blank" rel="noopener noreferrer">
<strong>Spec directory</strong>
<span>OpenAPI, schemas, and examples.</span>
</a>
<a class="link-card" href="https://github.com/Aimaghsoodi/GoalOS/tree/main/examples" target="_blank" rel="noopener noreferrer">
<strong>Examples</strong>
<span>Cloudflare Worker, Claude Desktop, LangChain, and CrewAI.</span>
</a>
<a class="link-card" href="https://huggingface.co/spaces/AbteeXAILab/GoalOS" target="_blank" rel="noopener noreferrer">
<strong>Hugging Face Space</strong>
<span>The public Space entry point.</span>
</a>
</div>
</section>
</main>
<footer class="site-footer">
<div class="shell footer-row">
<div class="brand brand-footer">
<span class="brand-mark" aria-hidden="true"></span>
<span>
<strong>GoalOS</strong>
<span>by AbteeX AI Labs</span>
</span>
</div>
<div class="footer-links">
<a href="../index.html">Home</a>
<a href="https://github.com/Aimaghsoodi/GoalOS" target="_blank" rel="noopener noreferrer">GitHub</a>
<a href="https://huggingface.co/spaces/AbteeXAILab/GoalOS" target="_blank" rel="noopener noreferrer">Hugging Face</a>
</div>
</div>
</footer>
<div class="toast" data-toast aria-live="polite" aria-atomic="true"></div>
<script src="../assets/app.js"></script>
</body>
</html>
|