import{A as e,d as t,m as n,t as r}from"./plugin-vue_export-helper-DazhzKqf.js";var i=JSON.parse(`{"path":"/guide/installation.html","title":"Installation","lang":"en-US","frontmatter":{},"git":{},"filePathRelative":"guide/installation.md"}`),a={name:`installation.md`};function o(r,i,a,o,s,c){return e(),t(`div`,null,[...i[0]||=[n(`<h1 id="installation" tabindex="-1"><a class="header-anchor" href="#installation"><span>Installation</span></a></h1><h2 id="requirements" tabindex="-1"><a class="header-anchor" href="#requirements"><span>Requirements</span></a></h2><ul><li><strong>Python 3.11+</strong></li><li>At least one LLM provider API key (e.g., <code>OPENAI_API_KEY</code>, <code>ANTHROPIC_API_KEY</code>, or <code>GOOGLE_API_KEY</code>).</li><li>Docker (optional, but recommended if using <code>DockerExecutor</code> for safe agent modifications).</li></ul><h2 id="standard-installation" tabindex="-1"><a class="header-anchor" href="#standard-installation"><span>Standard Installation</span></a></h2><p>Install the package directly from PyPI:</p><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh"><pre><code class="language-bash"><span class="line">pip <span class="token function">install</span> hyperflow-ai</span>
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h2 id="install-from-source" tabindex="-1"><a class="header-anchor" href="#install-from-source"><span>Install from Source</span></a></h2><p>For development and contributing, install from the source repository:</p><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh"><pre><code class="language-bash"><span class="line"><span class="token function">git</span> clone https://github.com/lablnet/HyperFlow.git</span>
<span class="line"><span class="token builtin class-name">cd</span> HyperFlow</span>
<span class="line">python3 <span class="token parameter variable">-m</span> venv .venv</span>
<span class="line"><span class="token builtin class-name">source</span> .venv/bin/activate</span>
<span class="line"></span>
<span class="line">pip <span class="token function">install</span> <span class="token parameter variable">-e</span> <span class="token string">".[dev]"</span></span>
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="environment-variables" tabindex="-1"><a class="header-anchor" href="#environment-variables"><span>Environment Variables</span></a></h2><p>HyperFlow relies on <code>.env</code> files to configure your workspace. Create an <code>.env</code> file in your root path:</p><table><thead><tr><th>Variable</th><th>Description</th></tr></thead><tbody><tr><td><code>OPENAI_API_KEY</code></td><td>OpenAI API key</td></tr><tr><td><code>ANTHROPIC_API_KEY</code></td><td>Anthropic API key</td></tr><tr><td><code>GOOGLE_API_KEY</code></td><td>Google Gemini API key</td></tr><tr><td><code>OLLAMA_BASE_URL</code></td><td>Ollama server URL (default: <code>http://localhost:11434</code>)</td></tr><tr><td><code>HYPERFLOW_MODEL</code></td><td>Default model for examples (e.g. <code>openai/gpt-4o</code>)</td></tr></tbody></table>`,12)]])}var s=r(a,[[`render`,o]]);export{i as _pageData,s as default};
|
Download
