1 line
No EOL
5.6 KiB
JavaScript
1 line
No EOL
5.6 KiB
JavaScript
"use strict";(globalThis.webpackChunkopenrag_docs=globalThis.webpackChunkopenrag_docs||[]).push([[961],{3929:(e,n,t)=>{t.d(n,{A:()=>s});const s=t.p+"assets/images/openrag_tui_dec_2025-c7022e66cc6675f25aced7b8acd8274d.png"},6239:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>d});const s=JSON.parse('{"id":"get-started/tui","title":"Use the TUI","description":"The OpenRAG Terminal User Interface (TUI) provides a simplified and guided experience for configuring, managing, and monitoring your OpenRAG deployment directly from the terminal.","source":"@site/docs/get-started/tui.mdx","sourceDirName":"get-started","slug":"/tui","permalink":"/tui","draft":false,"unlisted":false,"editUrl":"https://github.com/openrag/openrag/tree/main/docs/docs/get-started/tui.mdx","tags":[],"version":"current","frontMatter":{"title":"Use the TUI","slug":"/tui"},"sidebar":"tutorialSidebar","previous":{"title":"Remove OpenRAG","permalink":"/uninstall"},"next":{"title":"Manage services","permalink":"/manage-services"}}');var i=t(4848),r=t(8453);const o={title:"Use the TUI",slug:"/tui"},a=void 0,c={},d=[{value:"Access the TUI",id:"access-the-tui",level:2},{value:"Navigate the TUI",id:"navigate-the-tui",level:2},{value:"Manage services with the TUI",id:"manage-services-with-the-tui",level:2},{value:"Toggle GPU/CPU mode",id:"toggle-gpucpu-mode",level:2},{value:"Exit the OpenRAG TUI",id:"exit-the-openrag-tui",level:2}];function l(e){const n={a:"a",code:"code",h2:"h2",img:"img",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.p,{children:"The OpenRAG Terminal User Interface (TUI) provides a simplified and guided experience for configuring, managing, and monitoring your OpenRAG deployment directly from the terminal."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"OpenRAG TUI Interface",src:t(3929).A+"",width:"653",height:"397"})}),"\n",(0,i.jsxs)(n.p,{children:["If you install OpenRAG with the ",(0,i.jsx)(n.a,{href:"/install",children:"automatic installer script"}),", ",(0,i.jsx)(n.a,{href:"/install-uv",children:(0,i.jsx)(n.code,{children:"uv"})}),", or ",(0,i.jsx)(n.a,{href:"/install-uvx",children:(0,i.jsx)(n.code,{children:"uvx"})}),", you use the TUI to manage your OpenRAG deployment.\nThe TUI guides you through the initial setup, automatically manages your OpenRAG ",(0,i.jsx)(n.code,{children:".env"})," and ",(0,i.jsx)(n.code,{children:"docker-compose"})," files, and provides convenient access to ",(0,i.jsx)(n.a,{href:"/manage-services",children:"service management"})," controls."]}),"\n",(0,i.jsxs)(n.p,{children:["In contrast, when you ",(0,i.jsx)(n.a,{href:"/docker",children:"deploy OpenRAG with self-managed services"}),", you must manually configure OpenRAG by preparing a ",(0,i.jsx)(n.code,{children:".env"})," file, and then use Docker or Podman commands to deploy and manage your OpenRAG services."]}),"\n",(0,i.jsx)(n.h2,{id:"access-the-tui",children:"Access the TUI"}),"\n",(0,i.jsxs)(n.p,{children:["If you installed OpenRAG with ",(0,i.jsx)(n.code,{children:"uv"}),", access the TUI with ",(0,i.jsx)(n.code,{children:"uv run openrag"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["If you installed OpenRAG with the automatic installer script or ",(0,i.jsx)(n.code,{children:"uvx"}),", access the TUI with ",(0,i.jsx)(n.code,{children:"uvx openrag"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"navigate-the-tui",children:"Navigate the TUI"}),"\n",(0,i.jsx)(n.p,{children:"You can navigate the TUI with your mouse or keyboard.\nKeyboard shortcuts for additional menus are printed at the bottom of the TUI screen."}),"\n",(0,i.jsx)(n.h2,{id:"manage-services-with-the-tui",children:"Manage services with the TUI"}),"\n",(0,i.jsxs)(n.p,{children:["Use the TUI's ",(0,i.jsx)(n.strong,{children:"Status"})," page to access controls and information for your OpenRAG services.\nFor more information, see ",(0,i.jsx)(n.a,{href:"/manage-services",children:"Manage OpenRAG services"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"toggle-gpucpu-mode",children:"Toggle GPU/CPU mode"}),"\n",(0,i.jsx)(n.p,{children:"You can toggle between GPU and CPU mode from within the TUI if your system has compatible GPU hardware and drivers installed."}),"\n",(0,i.jsxs)(n.p,{children:["In the TUI, click ",(0,i.jsx)(n.strong,{children:"Status"}),", and then click ",(0,i.jsx)(n.strong,{children:"Switch to GPU Mode"})," or ",(0,i.jsx)(n.strong,{children:"Switch to CPU Mode"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["This change requires restarting all OpenRAG services because each mode has its own ",(0,i.jsx)(n.code,{children:"docker-compose"})," file."]}),"\n",(0,i.jsx)(n.h2,{id:"exit-the-openrag-tui",children:"Exit the OpenRAG TUI"}),"\n",(0,i.jsxs)(n.p,{children:["To exit the OpenRAG TUI, press ",(0,i.jsx)("kbd",{children:"q"})," on the TUI main page."]}),"\n",(0,i.jsx)(n.p,{children:"Exiting the TUI doesn't stop your OpenRAG services.\nYour OpenRAG services continue to run until they are stopped from within the TUI or by another process that inadvertently stops them."}),"\n",(0,i.jsxs)(n.p,{children:["To restart the TUI, see ",(0,i.jsx)(n.a,{href:"#access-the-tui",children:"Access the TUI"}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var s=t(6540);const i={},r=s.createContext(i);function o(e){const n=s.useContext(r);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); |