pengjunjie/langflow
1
0
Fork 1
mirror of https://github.com/langflow-ai/langflow.git synced 2026-07-24 06:10:49 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
00cdc37d88eaacc74f423eeec38c7c9fd93cc5d4
langflow/configuration-cli.html
github-merge-queue[bot] 00cdc37d88 deploy: 7c5cce6143
2025-01-29 19:03:49 +00:00

78 lines
42 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-Configuration/configuration-cli" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.7.0">
<title data-rh="true">Langflow CLI | Langflow Documentation</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.langflow.org/configuration-cli"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Langflow CLI | Langflow Documentation"><meta data-rh="true" name="description" content="The Langflow command line interface (Langflow CLI) is the main interface for managing and running the Langflow server."><meta data-rh="true" property="og:description" content="The Langflow command line interface (Langflow CLI) is the main interface for managing and running the Langflow server."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.langflow.org/configuration-cli"><link data-rh="true" rel="alternate" href="https://docs.langflow.org/configuration-cli" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.langflow.org/configuration-cli" hreflang="x-default"><link rel="preconnect" href="https://www.google-analytics.com">
<link rel="preconnect" href="https://www.googletagmanager.com">
<script async src="https://www.googletagmanager.com/gtag/js?id=G-XHC7G628ZP"></script>
<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-XHC7G628ZP",{anonymize_ip:!0})</script>
<link rel="preconnect" href="https://www.googletagmanager.com">
<script>window.dataLayer=window.dataLayer||[]</script>
<script>!function(e,t,a,n){e[n]=e[n]||[],e[n].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var g=t.getElementsByTagName(a)[0],m=t.createElement(a);m.async=!0,m.src="https://www.googletagmanager.com/gtm.js?id=GTM-NK5M4ZT8",g.parentNode.insertBefore(m,g)}(window,document,"script","dataLayer")</script><link rel="stylesheet" href="/assets/css/styles.dc07e493.css">
<script src="/assets/js/runtime~main.95fa44ae.js" defer="defer"></script>
<script src="/assets/js/main.cac72ebe.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-NK5M4ZT8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();null!==e?t(e):window.matchMedia("(prefers-color-scheme: dark)").matches?t("dark"):(window.matchMedia("(prefers-color-scheme: light)").matches,t("light"))}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top navbarHideable_m1mJ"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/langflow-logo-black.svg" alt="Langflow" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/langflow-logo-white.svg" alt="Langflow" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div></a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/langflow-ai/langflow" target="_blank" class="navbar__item navbar__link header-github-link"></a><a href="https://twitter.com/langflow_ai" target="_blank" class="navbar__item navbar__link header-twitter-link"></a><a href="https://discord.gg/EqksyE2EX9" target="_blank" class="navbar__item navbar__link header-discord-link"></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite" aria-pressed="false"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"><div class="mendable-search"><button id="ms-search-bar" style="background-color:#1a1a1a;border-color:#6B728033;color:#e1e3e7" class="dark-mode !ms-text-white hover:!ms-bg-opacity-75 hover:!ms-text-white focus:ms-bg-gray-800 focus:ms-bg-opacity-75 focus:ms-text-white ms-global search-btn__input ms-m-0 ms-flex ms-h-10 ms-w-full ms-flex-row ms-items-center ms-justify-between ms-gap-2 ms-bg-gray-50 ms-p-1 ms-px-2 ms-outline-none ms-ring-0 ms-transition-all hover:ms-cursor-pointer sm:ms-p-2 sm:ms-px-3 ms-border ms-rounded-xl"><div class="dark-mode ms-global search-btn__input-container ms-flex ms-w-full ms-min-w-0 ms-items-center ms-gap-0 sm:ms-gap-1"><svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 24 24" style="color:#e1e3e7;fill:#e1e3e7" class="dark-mode search-btn__icon hover:fill-white ms-h-5 ms-w-5 ms-fill-gray-400 hover:ms-text-white focus:ms-fill-white focus:ms-text-white sm:ms-h-6 sm:ms-w-6" height="20" width="20" xmlns="http://www.w3.org/2000/svg"><path fill="none" d="M0 0h24v24H0z"></path><path d="M15.5 14h-.79l-.28-.27A6.471 6.471 0 0016 9.5 6.5 6.5 0 109.5 16c1.61 0 3.09-.59 4.23-1.57l.27.28v.79l5 4.99L20.49 19l-4.99-5zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path></svg><div id="userInput" style="color:#e1e3e7" class="dark-mode ms-global search-btn__input ms-w-full ms-flex-grow ms-truncate ms-bg-transparent ms-text-sm ms-outline-none ms-ring-0 ms-ring-transparent focus:ms-outline-none focus:ms-ring-0 focus:ms-ring-transparent sm:ms-text-base ms-ml-1 ms-flex ms-items-start ms-justify-start">Search...</div></div><div style="background-color:#1a1a1a;border-color:#6B728033;color:#e1e3e7" class="dark-mode search-btn__shortcut ms-z-10 ms-flex ms-flex-row ms-items-center ms-gap-1 ms-rounded-lg ms-border ms-py-[2px] ms-px-[8px] ms-text-xs ms-text-gray-400 ms-transition-all disabled:ms-bg-opacity-10"><span>CTRL</span><span>K</span></div></button><div></div></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd sidebarWithHideableNavbar_wUlq"><a tabindex="-1" class="sidebarLogo_isFc" href="/"><img src="/img/langflow-logo-black.svg" alt="Langflow" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/langflow-logo-white.svg" alt="Langflow" class="themedComponent_mlkZ themedComponent--dark_xIcU"></a><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/">Welcome to Langflow</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/get-started-installation">Get started</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/starter-projects-basic-prompting">Starter projects</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/tutorials-blog-writer">Tutorials</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/concepts-overview">Concepts</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/components-agents">Components</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/agents-overview">Agents</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" href="/configuration-api-keys">Configuration</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/configuration-api-keys">API keys</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/configuration-authentication">Authentication</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/configuration-auto-save">Auto-saving</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/configuration-backend-only">Run Langflow in backend-only mode</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/configuration-cli">Langflow CLI</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/configuration-global-variables">Global variables</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/environment-variables">Environment variables</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/configuration-security-best-practices">Security best practices</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/Deployment/deployment-docker">Deployment</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/integrations-assemblyai">Integrations</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/contributing-community">Contributing</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/api-reference-api-examples">API reference</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a href="https://github.com/langflow-ai/langflow/releases/latest" target="_blank" rel="noopener noreferrer" class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false">Changelog</a></div></li></ul></nav><button type="button" title="Collapse sidebar" aria-label="Collapse sidebar" class="button button--secondary button--outline collapseSidebarButton_PEFL"><svg width="20" height="20" aria-hidden="true" class="collapseSidebarButtonIcon_kv0_"><g fill="#7a7a7a"><path d="M9.992 10.023c0 .2-.062.399-.172.547l-4.996 7.492a.982.982 0 01-.828.454H1c-.55 0-1-.453-1-1 0-.2.059-.403.168-.551l4.629-6.942L.168 3.078A.939.939 0 010 2.528c0-.548.45-.997 1-.997h2.996c.352 0 .649.18.828.45L9.82 9.472c.11.148.172.347.172.55zm0 0"></path><path d="M19.98 10.023c0 .2-.058.399-.168.547l-4.996 7.492a.987.987 0 01-.828.454h-3c-.547 0-.996-.453-.996-1 0-.2.059-.403.168-.551l4.625-6.942-4.625-6.945a.939.939 0 01-.168-.55 1 1 0 01.996-.997h3c.348 0 .649.18.828.45l4.996 7.492c.11.148.168.347.168.55zm0 0"></path></g></svg></button></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Configuration</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Langflow CLI</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><style>[data-ch-theme="github-dark"] { --ch-t-colorScheme: dark;--ch-t-foreground: #c9d1d9;--ch-t-background: #0d1117;--ch-t-lighter-inlineBackground: #0d1117e6;--ch-t-editor-background: #0d1117;--ch-t-editor-foreground: #c9d1d9;--ch-t-editor-lineHighlightBackground: #6e76811a;--ch-t-editor-rangeHighlightBackground: #ffffff0b;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #264F78;--ch-t-focusBorder: #1f6feb;--ch-t-tab-activeBackground: #0d1117;--ch-t-tab-activeForeground: #c9d1d9;--ch-t-tab-inactiveBackground: #010409;--ch-t-tab-inactiveForeground: #8b949e;--ch-t-tab-border: #30363d;--ch-t-tab-activeBorder: #0d1117;--ch-t-editorGroup-border: #30363d;--ch-t-editorGroupHeader-tabsBackground: #010409;--ch-t-editorLineNumber-foreground: #6e7681;--ch-t-input-background: #0d1117;--ch-t-input-foreground: #c9d1d9;--ch-t-input-border: #30363d;--ch-t-icon-foreground: #8b949e;--ch-t-sideBar-background: #010409;--ch-t-sideBar-foreground: #c9d1d9;--ch-t-sideBar-border: #30363d;--ch-t-list-activeSelectionBackground: #6e768166;--ch-t-list-activeSelectionForeground: #c9d1d9;--ch-t-list-hoverBackground: #6e76811a;--ch-t-list-hoverForeground: #c9d1d9; }</style>
<!-- -->
<header><h1>Langflow CLI</h1></header>
<p>The Langflow command line interface (Langflow CLI) is the main interface for managing and running the Langflow server.</p>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="cli-commands">CLI commands<a href="#cli-commands" class="hash-link" aria-label="Direct link to CLI commands" title="Direct link to CLI commands">​</a></h2>
<p>The following sections describe the available CLI commands and their options, as well as their corresponding <a href="/environment-variables">environment variables</a>.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="langflow">langflow<a href="#langflow" class="hash-link" aria-label="Direct link to langflow" title="Direct link to langflow">​</a></h3>
<p>Running the CLI without any arguments displays a list of available options and commands.</p>
<div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>langflow [OPTIONS]</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span># or</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>python -m langflow [OPTIONS]</span></div></div><br></code></div></div>
<h4 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="options">Options<a href="#options" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options">​</a></h4>
<table><thead><tr><th>Option</th><th>Default</th><th>Values</th><th>Description</th></tr></thead><tbody><tr><td><a id="install-completion"></a><code>--install-completion</code></td><td><em>Not applicable</em></td><td><em>Not applicable</em></td><td>Install auto-completion for the current shell.</td></tr><tr><td><a id="show-completion"></a><code>--show-completion</code></td><td><em>Not applicable</em></td><td><em>Not applicable</em></td><td>Show the location of the auto-completion config file (if installed).</td></tr><tr><td><a id="help"></a><code>--help</code></td><td><em>Not applicable</em></td><td><em>Not applicable</em></td><td>Display information about the command usage and its options and arguments.</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="langflow-api-key">langflow api-key<a href="#langflow-api-key" class="hash-link" aria-label="Direct link to langflow api-key" title="Direct link to langflow api-key">​</a></h3>
<p>Create an API key for the default superuser if the [<code>LANGFLOW_AUTO_LOGIN</code> environment variable] is set to <code>true</code>.</p>
<div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>langflow api-key [OPTIONS]</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span># or</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>python -m langflow api-key [OPTIONS]</span></div></div><br></code></div></div>
<h4 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="options-1">Options<a href="#options-1" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options">​</a></h4>
<table><thead><tr><th>Option</th><th>Default</th><th>Values</th><th>Description</th></tr></thead><tbody><tr><td><a id="install-completion"></a><code>--install-completion</code></td><td><em>Not applicable</em></td><td><em>Not applicable</em></td><td>Install auto-completion for the current shell.</td></tr><tr><td><a id="show-completion"></a><code>--show-completion</code></td><td><em>Not applicable</em></td><td><em>Not applicable</em></td><td>Show the location of the auto-completion config file (if installed).</td></tr><tr><td><a id="help"></a><code>--help</code></td><td><em>Not applicable</em></td><td><em>Not applicable</em></td><td>Display information about the command usage and its options and arguments.</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="langflow-copy-db">langflow copy-db<a href="#langflow-copy-db" class="hash-link" aria-label="Direct link to langflow copy-db" title="Direct link to langflow copy-db">​</a></h3>
<p>Copy the database files to the current directory.
Copy the Langflow database files, <code>langflow.db</code> and <code>langflow-pre.db</code> (if they exist), from the cache directory to the current directory.</p>
<div class="theme-admonition theme-admonition-note admonition_xJq3 alert alert--secondary"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"></path></svg></span>note</div><div class="admonitionContent_BuS1"><p>The current directory is the directory containing <code>__main__.py</code>.
You can find this directory by running <code>which langflow</code>.</p></div></div>
<div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>langflow copy-db</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span># or</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>python -m langflow copy-db</span></div></div><br></code></div></div>
<h4 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="options-2">Options<a href="#options-2" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options">​</a></h4>
<table><thead><tr><th>Option</th><th>Default</th><th>Values</th><th>Description</th></tr></thead><tbody><tr><td><a id="copy-db-help"></a><code>--help</code></td><td><em>Not applicable</em></td><td><em>Not applicable</em></td><td>Display information about the command usage and its options and arguments.</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="langflow-migration">langflow migration<a href="#langflow-migration" class="hash-link" aria-label="Direct link to langflow migration" title="Direct link to langflow migration">​</a></h3>
<p>Run or test database migrations.</p>
<div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>langflow migration [OPTIONS]</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span># or</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>python -m langflow migration [OPTIONS]</span></div></div><br></code></div></div>
<h4 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="options-3">Options<a href="#options-3" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options">​</a></h4>
<table><thead><tr><th>Option</th><th>Default</th><th>Values</th><th>Description</th></tr></thead><tbody><tr><td><a id="migration-test"></a><code>--test</code></td><td><code>true</code></td><td><a href="#boolean">Boolean</a></td><td>Run migrations in test mode. Use <code>--no-test</code> to disable test mode.</td></tr><tr><td><a id="migration-fix"></a><code>--fix</code></td><td><code>false</code> (<code>--no-fix</code>)</td><td><a href="#boolean">Boolean</a></td><td>Fix migrations. This is a destructive operation, and all affected data will be deleted. Only use this option if you know what you are doing.</td></tr><tr><td><a id="migration-help"></a><code>--help</code></td><td><em>Not applicable</em></td><td><em>Not applicable</em></td><td>Display information about the command usage and its options and arguments.</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="langflow-run">langflow run<a href="#langflow-run" class="hash-link" aria-label="Direct link to langflow run" title="Direct link to langflow run">​</a></h3>
<p>Start the Langflow server.</p>
<div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>langflow run [OPTIONS]</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span># or</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>python -m langflow run [OPTIONS]</span></div></div><br></code></div></div>
<h4 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="options-4">Options<a href="#options-4" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options">​</a></h4>
<table><thead><tr><th>Option</th><th>Default</th><th>Values</th><th>Description</th></tr></thead><tbody><tr><td><a id="run-host"></a><code>--host</code></td><td><code>127.0.0.1</code></td><td>String</td><td>The host on which the Langflow server will run.<br>See <a href="/environment-variables#LANGFLOW_HOST"><code>LANGFLOW_HOST</code> variable</a>.</td></tr><tr><td><a id="run-workers"></a><code>--workers</code></td><td><code>1</code></td><td>Integer</td><td>Number of worker processes.<br>See <a href="/environment-variables#LANGFLOW_WORKERS"><code>LANGFLOW_WORKERS</code> variable</a>.</td></tr><tr><td><a id="run-worker-timeout"></a><code>--worker-timeout</code></td><td><code>300</code></td><td>Integer</td><td>Worker timeout in seconds.<br>See <a href="/environment-variables#LANGFLOW_WORKER_TIMEOUT"><code>LANGFLOW_WORKER_TIMEOUT</code> variable</a>.</td></tr><tr><td><a id="run-port"></a><code>--port</code></td><td><code>7860</code></td><td>Integer</td><td>The port on which the Langflow server will run. The server automatically selects a free port if the specified port is in use.<br>See <a href="/environment-variables#LANGFLOW_PORT"><code>LANGFLOW_PORT</code> variable</a>.</td></tr><tr><td><a id="run-components-path"></a><code>--components-path</code></td><td><code>langflow/components</code></td><td>String</td><td>Path to the directory containing custom components.<br>See <a href="/environment-variables#LANGFLOW_COMPONENTS_PATH"><code>LANGFLOW_COMPONENTS_PATH</code> variable</a>.</td></tr><tr><td><a id="run-env-file"></a><code>--env-file</code></td><td>Not set</td><td>String</td><td>Path to the <code>.env</code> file containing environment variables.<br>See <a href="/environment-variables#configure-variables-env-file">Import environment variables from a .env file</a>.</td></tr><tr><td><a id="run-log-level"></a><code>--log-level</code></td><td><code>critical</code></td><td><code>debug</code><br><code>info</code><br><code>warning</code><br><code>error</code><br><code>critical</code></td><td>Set the logging level.<br>See <a href="/environment-variables#LANGFLOW_LOG_LEVEL"><code>LANGFLOW_LOG_LEVEL</code> variable</a>.</td></tr><tr><td><a id="run-log-file"></a><code>--log-file</code></td><td><code>logs/langflow.log</code></td><td>String</td><td>Set the path to the log file for Langflow.<br>See <a href="/environment-variables#LANGFLOW_LOG_FILE"><code>LANGFLOW_LOG_FILE</code> variable</a>.</td></tr><tr><td><a id="run-cache"></a><code>--cache</code></td><td><code>InMemoryCache</code></td><td><code>InMemoryCache</code><br><code>SQLiteCache</code></td><td>Type of cache to use.<br>See <a href="/environment-variables#LANGFLOW_LANGCHAIN_CACHE"><code>LANGFLOW_LANGCHAIN_CACHE</code> variable</a>.</td></tr><tr><td><a id="run-dev"></a><code>--dev</code></td><td><code>false</code> (<code>--no-dev</code>)</td><td><a href="#boolean">Boolean</a></td><td>Run Langflow in development mode (may contain bugs).<br>See <a href="/environment-variables#LANGFLOW_DEV"><code>LANGFLOW_DEV</code> variable</a>.</td></tr><tr><td><a id="run-frontend-path"></a><code>--frontend-path</code></td><td><code>./frontend</code></td><td>String</td><td>Path to the frontend directory containing build files. This is for development purposes only.<br>See <a href="/environment-variables#LANGFLOW_FRONTEND_PATH"><code>LANGFLOW_FRONTEND_PATH</code> variable</a>.</td></tr><tr><td><a id="run-open-browser"></a><code>--open-browser</code></td><td><code>true</code></td><td><a href="#boolean">Boolean</a></td><td>Open the system web browser on startup. Use <code>--no-open-browser</code> to disable opening the system web browser on startup.<br> See <a href="/environment-variables#LANGFLOW_OPEN_BROWSER"><code>LANGFLOW_OPEN_BROWSER</code> variable</a>.</td></tr><tr><td><a id="run-remove-api-keys"></a><code>--remove-api-keys</code></td><td><code>false</code> (<code>--no-remove-api-keys</code>)</td><td><a href="#boolean">Boolean</a></td><td>Remove API keys from the projects saved in the database.<br> See <a href="/environment-variables#LANGFLOW_REMOVE_API_KEYS"><code>LANGFLOW_REMOVE_API_KEYS</code> variable</a>.</td></tr><tr><td><a id="run-backend-only"></a><code>--backend-only</code></td><td><code>false</code> (<code>--no-backend-only</code>)</td><td><a href="#boolean">Boolean</a></td><td>Only run Langflow&#x27;s backend server (no frontend).<br>See <a href="/environment-variables#LANGFLOW_BACKEND_ONLY"><code>LANGFLOW_BACKEND_ONLY</code> variable</a>.</td></tr><tr><td><a id="run-store"></a><code>--store</code></td><td><code>true</code></td><td><a href="#boolean">Boolean</a></td><td>Enable the Langflow Store features. Use <code>--no-store</code> to disable the Langflow Store features.<br>See <a href="/environment-variables#LANGFLOW_STORE"><code>LANGFLOW_STORE</code> variable</a>.</td></tr><tr><td><a id="run-auto-saving"></a><code>--auto-saving</code></td><td><code>true</code></td><td><a href="#boolean">Boolean</a></td><td>Enable flow auto-saving. Use <code>--no-auto-saving</code> to disable flow auto-saving.<br>See <a href="/environment-variables#LANGFLOW_AUTO_SAVING"><code>LANGFLOW_AUTO_SAVING</code> variable</a>.</td></tr><tr><td><a id="run-auto-saving-interval"></a><code>--auto-saving-interval</code></td><td><code>1000</code></td><td>Integer</td><td>Set the interval for flow auto-saving in milliseconds.<br>See <a href="/environment-variables#LANGFLOW_AUTO_SAVING_INTERVAL"><code>LANGFLOW_AUTO_SAVING_INTERVAL</code> variable</a>.</td></tr><tr><td><a id="run-health-check-max-retries"></a><code>--health-check-max-retries</code></td><td><code>5</code></td><td>Integer</td><td>Set the maximum number of retries for the health check. Use <code>--no-health-check-max-retries</code> to disable the maximum number of retries for the health check.<br>See <a href="/environment-variables#LANGFLOW_HEALTH_CHECK_MAX_RETRIES"><code>LANGFLOW_HEALTH_CHECK_MAX_RETRIES</code> variable</a>.</td></tr><tr><td><a id="run-max-file-size-upload"></a><code>--max-file-size-upload</code></td><td><code>100</code></td><td>Integer</td><td>Set the maximum file size for the upload in megabytes.<br>See <a href="/environment-variables#LANGFLOW_MAX_FILE_SIZE_UPLOAD"><code>LANGFLOW_MAX_FILE_SIZE_UPLOAD</code> variable</a>.</td></tr><tr><td><a id="run-help"></a><code>--help</code></td><td><em>Not applicable</em></td><td><em>Not applicable</em></td><td>Display information about the command usage and its options and arguments.</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="langflow-superuser">langflow superuser<a href="#langflow-superuser" class="hash-link" aria-label="Direct link to langflow superuser" title="Direct link to langflow superuser">​</a></h3>
<p>Create a superuser account.</p>
<div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>langflow superuser [OPTIONS]</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span># or</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>python -m langflow superuser [OPTIONS]</span></div></div><br></code></div></div>
<h4 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="options-5">Options<a href="#options-5" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options">​</a></h4>
<table><thead><tr><th>Option</th><th>Default</th><th>Values</th><th>Description</th></tr></thead><tbody><tr><td><a id="superuser-username"></a><code>--username</code></td><td>Required</td><td>String</td><td>Specify the name for the superuser.<br>See <a href="/environment-variables#LANGFLOW_SUPERUSER"><code>LANGFLOW_SUPERUSER</code> variable</a>.</td></tr><tr><td><a id="superuser-password"></a><code>--password</code></td><td>Required</td><td>String</td><td>Specify the password for the superuser.<br>See <a href="/environment-variables#LANGFLOW_SUPERUSER_PASSWORD"><code>LANGFLOW_SUPERUSER_PASSWORD</code> variable</a>.</td></tr><tr><td><a id="superuser-log-level"></a><code>--log-level</code></td><td><code>critical</code></td><td><code>debug</code><br><code>info</code><br><code>warning</code><br><code>error</code><br><code>critical</code></td><td>Set the logging level.</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="precedence">Precedence<a href="#precedence" class="hash-link" aria-label="Direct link to Precedence" title="Direct link to Precedence">​</a></h2>
<p>Langflow CLI options override the values of corresponding <a href="/environment-variables">environment variables</a>.</p>
<p>For example, if you have <code>LANGFLOW_PORT=7860</code> defined as an environment variable, but you run the CLI with <code>--port 7880</code>, then Langflow will set the port to <strong><code>7880</code></strong> (the value passed with the CLI).</p>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="assign-values">Assign values<a href="#assign-values" class="hash-link" aria-label="Direct link to Assign values" title="Direct link to Assign values">​</a></h2>
<p>There are two ways you can assign a value to a CLI option.
You can write the option flag and its value with a single space between them: <code>--option value</code>.
Or, you can write them using an equals sign (<code>=</code>) between the option flag and the value: <code>--option=value</code>.</p>
<p>Values that contain spaces must be surrounded by quotation marks: <code>--option &#x27;Value with Spaces&#x27;</code> or <code>--option=&#x27;Value with Spaces&#x27;</code>.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="boolean">Boolean values<a href="#boolean" class="hash-link" aria-label="Direct link to Boolean values" title="Direct link to Boolean values">​</a></h3>
<p>Boolean options turn a behavior on or off, and therefore accept no arguments.
To activate a boolean option, type it on the command line.
For example:</p>
<div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>langflow run --remove-api-keys</span></div></div><br></code></div></div>
<p>All boolean options have a corresponding option that negates it.
For example, the negating option for <code>--remove-api-keys</code> is <code>--no-remove-api-keys</code>.
These options let you negate boolean options that you may have set using <a href="/environment-variables">environment variables</a>.</p></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/configuration-backend-only"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Run Langflow in backend-only mode</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/configuration-global-variables"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Global variables</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#cli-commands" class="table-of-contents__link toc-highlight">CLI commands</a><ul><li><a href="#langflow" class="table-of-contents__link toc-highlight">langflow</a></li><li><a href="#langflow-api-key" class="table-of-contents__link toc-highlight">langflow api-key</a></li><li><a href="#langflow-copy-db" class="table-of-contents__link toc-highlight">langflow copy-db</a></li><li><a href="#langflow-migration" class="table-of-contents__link toc-highlight">langflow migration</a></li><li><a href="#langflow-run" class="table-of-contents__link toc-highlight">langflow run</a></li><li><a href="#langflow-superuser" class="table-of-contents__link toc-highlight">langflow superuser</a></li></ul></li><li><a href="#precedence" class="table-of-contents__link toc-highlight">Precedence</a></li><li><a href="#assign-values" class="table-of-contents__link toc-highlight">Assign values</a><ul><li><a href="#boolean" class="table-of-contents__link toc-highlight">Boolean values</a></li></ul></li></ul></div></div></div></div></main></div></div></div><div id="ms-floating-button" class="ms-fixed ms-bottom-4 ms-right-8 ms-z-[100] ms-flex ms-flex-col ms-items-end hover:ms-cursor-pointer"><div class="ms-relative ms-mb-4"><div style="background-color:#f6f6f6" class="ms-absolute -ms-bottom-1 ms-right-6 -ms-z-10 ms-h-4 ms-w-4 ms-rotate-45"></div><div style="background-color:#f6f6f6" class="ms-z-10 ms-flex ms-items-center ms-justify-center ms-rounded-lg ms-px-3 ms-py-2"><p style="color:#000000;margin:0" class="ms-text-sm">Hi, how can I help you?</p></div></div><div style="background-color:#f6f6f6" class="ms-flex ms-h-16 ms-w-16 ms-flex-col ms-items-center ms-justify-center ms-self-end ms-rounded-full ms-p-2 ms-transition"><div class="ms-rotate-0 ms-flex ms-h-full ms-w-full ms-transform ms-cursor-pointer ms-items-center ms-justify-center ms-rounded-full ms-transition-all ms-delay-75 ms-duration-100 ms-ease-in-out"><div style="color:#000000;font-size:22px;width:48px;height:48px;margin:0px;padding:0px;display:flex;align-items:center;justify-content:center;text-align:center"><img src="/img/langflow-icon-black-transparent.svg" srcdark="" style="width:40px"></div></div></div><div></div></div></div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink