chat-ui/pr_2483/en/index.html

<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;Chat UI&quot;,&quot;local&quot;:&quot;chat-ui&quot;,&quot;sections&quot;:[{&quot;title&quot;:&quot;Quickstart&quot;,&quot;local&quot;:&quot;quickstart&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2}],&quot;depth&quot;:1}"/>
		<link href="/docs/chat-ui/pr_2483/en/_app/immutable/entry/start.dwGV5vLe.js" rel="modulepreload">
		<link href="/docs/chat-ui/pr_2483/en/_app/immutable/chunks/Cz4Eld81.js" rel="modulepreload">
		<link href="/docs/chat-ui/pr_2483/en/_app/immutable/chunks/BAlBQgxm.js" rel="modulepreload">
		<link href="/docs/chat-ui/pr_2483/en/_app/immutable/entry/app.CU5IVJTF.js" rel="modulepreload">
		<link href="/docs/chat-ui/pr_2483/en/_app/immutable/chunks/CShA6w_M.js" rel="modulepreload">
		<link href="/docs/chat-ui/pr_2483/en/_app/immutable/chunks/Dx0EZ-sO.js" rel="modulepreload">
		<link href="/docs/chat-ui/pr_2483/en/_app/immutable/chunks/DsnmJJEf.js" rel="modulepreload">
		<link href="/docs/chat-ui/pr_2483/en/_app/immutable/chunks/BdEMyugS.js" rel="modulepreload">
		<link href="/docs/chat-ui/pr_2483/en/_app/immutable/nodes/0.BERXynV3.js" rel="modulepreload">
		<link href="/docs/chat-ui/pr_2483/en/_app/immutable/chunks/BchC4-7E.js" rel="modulepreload">
		<link href="/docs/chat-ui/pr_2483/en/_app/immutable/nodes/10.DmqYCV_M.js" rel="modulepreload">
		<link href="/docs/chat-ui/pr_2483/en/_app/immutable/chunks/Bf3_1seQ.js" rel="modulepreload">
		<!--1ldsu9f--><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;Chat UI&quot;,&quot;local&quot;:&quot;chat-ui&quot;,&quot;sections&quot;:[{&quot;title&quot;:&quot;Quickstart&quot;,&quot;local&quot;:&quot;quickstart&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2}],&quot;depth&quot;:1}"/><!---->
		<link href="/docs/chat-ui/pr_2483/en/_app/immutable/assets/0.tn0RQdqM.css" rel="modulepreload"> <!--[--><!--[0--><!--[--><!--[0--><!--[--><p></p> <div class="items-center shrink-0 min-w-[100px] max-sm:min-w-[50px] justify-end ml-auto flex" style="float: right; margin-left: 10px; display: inline-flex; position: relative; z-index: 10;"><div class="inline-flex rounded-md max-sm:rounded-sm"><button class="inline-flex items-center gap-1 h-7 max-sm:h-7 px-2 max-sm:px-1.5 text-sm font-medium text-gray-800 border border-r-0 rounded-l-md max-sm:rounded-l-sm border-gray-200 bg-white hover:shadow-inner dark:border-gray-850 dark:bg-gray-950 dark:text-gray-200 dark:hover:bg-gray-800" aria-live="polite"><span class="inline-flex items-center justify-center rounded-md p-0.5 max-sm:p-0 hover:text-gray-800 dark:hover:text-gray-200"><svg class="sm:size-3.5 size-3" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg><!----></span> <span>Copy page</span></button> <button class="inline-flex items-center justify-center w-6 max-sm:w-5 h-7 max-sm:h-7 disabled:pointer-events-none text-sm text-gray-500 hover:text-gray-700 dark:hover:text-white rounded-r-md max-sm:rounded-r-sm border border-l transition border-gray-200 bg-white hover:shadow-inner dark:border-gray-850 dark:bg-gray-950 dark:text-gray-200 dark:hover:bg-gray-800" aria-haspopup="menu" aria-expanded="false" aria-label="Open copy menu"><svg class="transition-transform text-gray-400 overflow-visible sm:size-3.5 size-3 rotate-0" width="1em" height="1em" viewBox="0 0 12 7" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M1 1L6 6L11 1" stroke="currentColor"></path></svg><!----></button></div> <!--[-1--><!--]--></div><!----> <!--[0--><h1 class="relative group"><a id="chat-ui" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#chat-ui"><span><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg><!----></span></a> <span>Chat UI</span></h1><!--]--><!----> <p>Open source chat interface with support for tools, multimodal inputs, and intelligent routing across models. The app uses MongoDB and SvelteKit behind the scenes. Try the live version called <a href="https://huggingface.co/chat" rel="nofollow">HuggingChat on hf.co/chat</a> or <a href="./installation/local">setup your own instance</a>.</p> <p>Chat UI connects to any OpenAI-compatible API endpoint, making it work with:</p> <ul><li><a href="https://huggingface.co/docs/inference-providers" rel="nofollow">Hugging Face Inference Providers</a></li> <li><a href="https://ollama.ai" rel="nofollow">Ollama</a></li> <li><a href="https://github.com/ggerganov/llama.cpp" rel="nofollow">llama.cpp</a></li> <li><a href="https://openrouter.ai" rel="nofollow">OpenRouter</a></li> <li>Any other OpenAI-compatible service</li></ul> <p><strong><a href="./configuration/mcp-tools">MCP Tools</a></strong>: Function calling via Model Context Protocol (MCP) servers</p> <p><strong><a href="./configuration/llm-router">LLM Router</a></strong>: Intelligent routing to select the best model for each request</p> <p><strong><a href="./configuration/overview">Multimodal</a></strong>: Image uploads on models that support vision</p> <p><strong><a href="./configuration/open-id">OpenID</a></strong>: Optional user authentication via OpenID Connect</p> <!--[1--><h2 class="relative group"><a id="quickstart" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#quickstart"><span><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg><!----></span></a> <span>Quickstart</span></h2><!--]--><!----> <p><strong>Step 1 - Create <code>.env.local</code>:</strong></p> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5   text-gray-600  " title="code excerpt" type="button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg><!----> <div class=" absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0 "><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent;"></div> Copied</div><!----></button><!----></div> <pre class="language-ini "><!----><span class="hljs-attr">OPENAI_BASE_URL</span>=https://router.huggingface.co/v1
<span class="hljs-attr">OPENAI_API_KEY</span>=hf_************************<!----></pre></div><!----> <p>You can use any OpenAI-compatible endpoint:</p> <table><thead><tr><th>Provider</th><th><code>OPENAI_BASE_URL</code></th><th><code>OPENAI_API_KEY</code></th></tr></thead><tbody><tr><td>Hugging Face</td><td><code>https://router.huggingface.co/v1</code></td><td><code>hf_xxx</code></td></tr><tr><td>Ollama</td><td><code>http://127.0.0.1:11434/v1</code></td><td><code>ollama</code></td></tr><tr><td>llama.cpp</td><td><code>http://127.0.0.1:8080/v1</code></td><td><code>sk-local</code></td></tr><tr><td>OpenRouter</td><td><code>https://openrouter.ai/api/v1</code></td><td><code>sk-or-v1-xxx</code></td></tr></tbody></table> <p><strong>Step 2 - Install and run:</strong></p> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5   text-gray-600  " title="code excerpt" type="button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg><!----> <div class=" absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0 "><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent;"></div> Copied</div><!----></button><!----></div> <pre class="language-bash "><!---->git <span class="hljs-built_in">clone</span> https://github.com/huggingface/chat-ui
<span class="hljs-built_in">cd</span> chat-ui
npm install
npm run dev -- --open<!----></pre></div><!----> <p>That’s it! Chat UI will automatically discover available models from your endpoint.</p> <blockquote class="tip"><p>MongoDB is optional for development. When <code>MONGODB_URL</code> is not set, Chat UI uses an embedded database that persists to <code>./db</code>.</p></blockquote> <p>For production deployments, see the <a href="./installation/local">installation guides</a>.</p> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/chat-ui/blob/main/docs/source/index.md" target="_blank"><svg class="mr-1" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M31,16l-7,7l-1.41-1.41L28.17,16l-5.58-5.59L24,9l7,7z"></path><path d="M1,16l7-7l1.41,1.41L3.83,16l5.58,5.59L8,23l-7-7z"></path><path d="M12.419,25.484L17.639,6.552l1.932,0.518L14.351,26.002z"></path></svg><!----> <span><span class="underline">Update</span> on GitHub</span></a><!----> <p></p><!--]--><!----><!--]--><!--]--><!--]--> <!--[-1--><!--]--><!--]-->
			
			<script>
				{
					__sveltekit_1la0tkn = {
						base: "/docs/chat-ui/pr_2483/en",
						assets: "/docs/chat-ui/pr_2483/en"
					};

					const element = document.currentScript.parentElement;

					Promise.all([
						import("/docs/chat-ui/pr_2483/en/_app/immutable/entry/start.dwGV5vLe.js"),
						import("/docs/chat-ui/pr_2483/en/_app/immutable/entry/app.CU5IVJTF.js")
					]).then(([kit, app]) => {
						kit.start(app, element, {
							node_ids: [0, 10],
							data: [null,null],
							form: null,
							error: null
						});
					});
				}
			</script>