docs-archive/1.10.8/cli.html - airflow-site - Git at Google



 <!--
 Javascript to render AIRFLOW-XXX and PR references in text
 as HTML links.

 Overrides extrahead block from sphinx_rtd_theme
 https://www.sphinx-doc.org/en/master/templating.html
 -->


 <!DOCTYPE html>
 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
 <head>
   <meta charset="utf-8">

   <meta name="viewport" content="width=device-width, initial-scale=1.0">

   <title>Command Line Interface Reference &mdash; Airflow Documentation</title>


     <link rel="shortcut icon" href="_static/pin_32.png"/>


   <script type="text/javascript" src="_static/js/modernizr.min.js"></script>


       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
         <script type="text/javascript" src="_static/jquery.js"></script>
         <script type="text/javascript" src="_static/underscore.js"></script>
         <script type="text/javascript" src="_static/doctools.js"></script>
         <script type="text/javascript" src="_static/language_data.js"></script>
         <script type="text/javascript" src="_static/jira-links.js"></script>

     <script type="text/javascript" src="_static/js/theme.js"></script>


   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
   <link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
   <link rel="stylesheet" href="_static/exampleinclude.css" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Scheduling &amp; Triggers" href="scheduler.html" />
     <link rel="prev" title="Data Profiling" href="profiling.html" />

   <script>
   </script>
   <style>

   </style>

 </head>

 <body class="wy-body-for-nav">


   <div class="wy-grid-for-nav">

     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >


             <a href="index.html" class="icon icon-home"> Airflow


           </a>


               <div class="version">
                 1.10.8
               </div>


 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
     <input type="text" name="q" placeholder="Search docs" />
     <input type="hidden" name="check_keywords" value="yes" />
     <input type="hidden" name="area" value="default" />
   </form>
 </div>


         </div>

         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">


               <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="project.html">Project</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
 <li class="toctree-l1"><a class="reference internal" href="start.html">Quick Start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
 <li class="toctree-l1"><a class="reference internal" href="howto/index.html">How-to Guides</a></li>
 <li class="toctree-l1"><a class="reference internal" href="ui.html">UI / Screenshots</a></li>
 <li class="toctree-l1"><a class="reference internal" href="concepts.html">Concepts</a></li>
 <li class="toctree-l1"><a class="reference internal" href="profiling.html">Data Profiling</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Command Line Interface Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="scheduler.html">Scheduling &amp; Triggers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="executor/index.html">Executor</a></li>
 <li class="toctree-l1"><a class="reference internal" href="plugins.html">Plugins</a></li>
 <li class="toctree-l1"><a class="reference internal" href="security.html">Security</a></li>
 <li class="toctree-l1"><a class="reference internal" href="timezone.html">Time zones</a></li>
 <li class="toctree-l1"><a class="reference internal" href="api.html">REST API Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="integration.html">Integration</a></li>
 <li class="toctree-l1"><a class="reference internal" href="metrics.html">Metrics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="errors.html">Error Tracking</a></li>
 <li class="toctree-l1"><a class="reference internal" href="kubernetes.html">Kubernetes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="lineage.html">Lineage</a></li>
 <li class="toctree-l1"><a class="reference internal" href="dag-serialization.html">DAG Serialization</a></li>
 <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
 <li class="toctree-l1"><a class="reference internal" href="best-practices.html">Best Practices</a></li>
 <li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li>
 <li class="toctree-l1"><a class="reference internal" href="macros.html">Macros reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="privacy_notice.html">Privacy Notice</a></li>
 </ul>
 <p class="caption"><span class="caption-text">References</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="_api/index.html">Python API</a></li>
 <li class="toctree-l1"><a class="reference internal" href="configurations-ref.html">Configurations</a></li>
 </ul>


         </div>
       </div>
     </nav>

     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


       <nav class="wy-nav-top" aria-label="top navigation">

           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
           <a href="index.html">Airflow</a>

       </nav>


       <div class="wy-nav-content">

         <div class="rst-content">


 <div role="navigation" aria-label="breadcrumbs navigation">

   <ul class="wy-breadcrumbs">

       <li><a href="index.html">Docs</a> &raquo;</li>

       <li>Command Line Interface Reference</li>


       <li class="wy-breadcrumbs-aside">


             <a href="_sources/cli.rst.txt" rel="nofollow"> View page source</a>


       </li>

   </ul>


   <hr/>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">

   <blockquote>
 <div></div></blockquote>
 <div class="section" id="command-line-interface-reference">
 <span id="cli"></span><h1>Command Line Interface Reference<a class="headerlink" href="#command-line-interface-reference" title="Permalink to this headline">¶</a></h1>
 <p>Airflow has a very rich command line interface that allows for
 many types of operation on a DAG, starting services, and supporting
 development and testing.</p>
 <div class="system-message">
 <p class="system-message-title">System Message: ERROR/3 (<span class="docutils literal">/Users/kaxilnaik/Documents/GitHub/apache-airflow/docs/cli.rst</span>, line 31)</p>
 <p>Failed to import “get_parser” from “airflow.bin.cli”.
 cannot import name ‘secure_filename’ from ‘werkzeug’ (/Users/kaxilnaik/.virtualenvs/airflow_1.10.8/lib/python3.7/site-packages/werkzeug/__init__.py)</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">argparse</span><span class="p">::</span>
    <span class="p">:</span><span class="n">module</span><span class="p">:</span> <span class="n">airflow</span><span class="o">.</span><span class="n">bin</span><span class="o">.</span><span class="n">cli</span>
    <span class="p">:</span><span class="n">func</span><span class="p">:</span> <span class="n">get_parser</span>
    <span class="p">:</span><span class="n">prog</span><span class="p">:</span> <span class="n">airflow</span>
 </pre></div>
 </div>
 </div>
 </div>


            </div>

           </div>


 <footer>

     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

         <a href="scheduler.html" class="btn btn-neutral float-right" title="Scheduling &amp; Triggers" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


         <a href="profiling.html" class="btn btn-neutral float-left" title="Data Profiling" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

     </div>


   <hr/>

   <div role="contentinfo">
     <p>

     </p>
   </div>
   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
   <div class="footer">This page uses <a href="https://analytics.google.com/">
     Google Analytics</a> to collect statistics. You can disable it by blocking
     the JavaScript coming from www.google-analytics.com. Check our
     <a href="privacy_notice.html">Privacy Policy</a>
     for more details.
   </div>


 </footer>

         </div>
       </div>

     </section>

   </div>


   <script type="text/javascript">
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
   </script>


     <!-- Theme Analytics -->
     <script>
     (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
       (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
       m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
     })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

     ga('create', 'UA-140539454-1', 'auto');
     ga('send', 'pageview');
     </script>


 </body>
 </html>


	<!--
	Javascript to render AIRFLOW-XXX and PR references in text
	as HTML links.

	Overrides extrahead block from sphinx_rtd_theme
	https://www.sphinx-doc.org/en/master/templating.html
	-->


	<!DOCTYPE html>
	<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
	<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
	<head>
	<meta charset="utf-8">

	<meta name="viewport" content="width=device-width, initial-scale=1.0">

	<title>Command Line Interface Reference — Airflow Documentation</title>




	<link rel="shortcut icon" href="_static/pin_32.png"/>





	<script type="text/javascript" src="_static/js/modernizr.min.js"></script>


	<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
	<script type="text/javascript" src="_static/jquery.js"></script>
	<script type="text/javascript" src="_static/underscore.js"></script>
	<script type="text/javascript" src="_static/doctools.js"></script>
	<script type="text/javascript" src="_static/language_data.js"></script>
	<script type="text/javascript" src="_static/jira-links.js"></script>

	<script type="text/javascript" src="_static/js/theme.js"></script>




	<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
	<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
	<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
	<link rel="stylesheet" href="_static/exampleinclude.css" type="text/css" />
	<link rel="index" title="Index" href="genindex.html" />
	<link rel="search" title="Search" href="search.html" />
	<link rel="next" title="Scheduling & Triggers" href="scheduler.html" />
	<link rel="prev" title="Data Profiling" href="profiling.html" />

	<script>
	</script>
	<style>

	</style>

	</head>

	<body class="wy-body-for-nav">


	<div class="wy-grid-for-nav">

	<nav data-toggle="wy-nav-shift" class="wy-nav-side">
	<div class="wy-side-scroll">
	<div class="wy-side-nav-search" >



	<a href="index.html" class="icon icon-home"> Airflow



	</a>




	<div class="version">
	1.10.8
	</div>




	<div role="search">
	<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
	<input type="text" name="q" placeholder="Search docs" />
	<input type="hidden" name="check_keywords" value="yes" />
	<input type="hidden" name="area" value="default" />
	</form>
	</div>


	</div>

	<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">






	<ul class="current">
	<li class="toctree-l1"><a class="reference internal" href="project.html">Project</a></li>
	<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
	<li class="toctree-l1"><a class="reference internal" href="start.html">Quick Start</a></li>
	<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
	<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
	<li class="toctree-l1"><a class="reference internal" href="howto/index.html">How-to Guides</a></li>
	<li class="toctree-l1"><a class="reference internal" href="ui.html">UI / Screenshots</a></li>
	<li class="toctree-l1"><a class="reference internal" href="concepts.html">Concepts</a></li>
	<li class="toctree-l1"><a class="reference internal" href="profiling.html">Data Profiling</a></li>
	<li class="toctree-l1 current"><a class="current reference internal" href="#">Command Line Interface Reference</a></li>
	<li class="toctree-l1"><a class="reference internal" href="scheduler.html">Scheduling & Triggers</a></li>
	<li class="toctree-l1"><a class="reference internal" href="executor/index.html">Executor</a></li>
	<li class="toctree-l1"><a class="reference internal" href="plugins.html">Plugins</a></li>
	<li class="toctree-l1"><a class="reference internal" href="security.html">Security</a></li>
	<li class="toctree-l1"><a class="reference internal" href="timezone.html">Time zones</a></li>
	<li class="toctree-l1"><a class="reference internal" href="api.html">REST API Reference</a></li>
	<li class="toctree-l1"><a class="reference internal" href="integration.html">Integration</a></li>
	<li class="toctree-l1"><a class="reference internal" href="metrics.html">Metrics</a></li>
	<li class="toctree-l1"><a class="reference internal" href="errors.html">Error Tracking</a></li>
	<li class="toctree-l1"><a class="reference internal" href="kubernetes.html">Kubernetes</a></li>
	<li class="toctree-l1"><a class="reference internal" href="lineage.html">Lineage</a></li>
	<li class="toctree-l1"><a class="reference internal" href="dag-serialization.html">DAG Serialization</a></li>
	<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
	<li class="toctree-l1"><a class="reference internal" href="best-practices.html">Best Practices</a></li>
	<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li>
	<li class="toctree-l1"><a class="reference internal" href="macros.html">Macros reference</a></li>
	<li class="toctree-l1"><a class="reference internal" href="privacy_notice.html">Privacy Notice</a></li>
	</ul>
	<p class="caption"><span class="caption-text">References</span></p>
	<ul>
	<li class="toctree-l1"><a class="reference internal" href="_api/index.html">Python API</a></li>
	<li class="toctree-l1"><a class="reference internal" href="configurations-ref.html">Configurations</a></li>
	</ul>



	</div>
	</div>
	</nav>

	<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


	<nav class="wy-nav-top" aria-label="top navigation">

	<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
	<a href="index.html">Airflow</a>

	</nav>


	<div class="wy-nav-content">

	<div class="rst-content">

















	<div role="navigation" aria-label="breadcrumbs navigation">

	<ul class="wy-breadcrumbs">

	<li><a href="index.html">Docs</a> »</li>

	<li>Command Line Interface Reference</li>


	<li class="wy-breadcrumbs-aside">


	<a href="_sources/cli.rst.txt" rel="nofollow"> View page source</a>


	</li>

	</ul>


	<hr/>
	</div>
	<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
	<div itemprop="articleBody">

	<blockquote>
	<div></div></blockquote>
	<div class="section" id="command-line-interface-reference">
	<span id="cli"></span><h1>Command Line Interface Reference<a class="headerlink" href="#command-line-interface-reference" title="Permalink to this headline">¶</a></h1>
	<p>Airflow has a very rich command line interface that allows for
	many types of operation on a DAG, starting services, and supporting
	development and testing.</p>
	<div class="system-message">
	<p class="system-message-title">System Message: ERROR/3 (<span class="docutils literal">/Users/kaxilnaik/Documents/GitHub/apache-airflow/docs/cli.rst</span>, line 31)</p>
	<p>Failed to import “get_parser” from “airflow.bin.cli”.
	cannot import name ‘secure_filename’ from ‘werkzeug’ (/Users/kaxilnaik/.virtualenvs/airflow_1.10.8/lib/python3.7/site-packages/werkzeug/__init__.py)</p>
	<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">argparse</span><span class="p">::</span>
	<span class="p">:</span><span class="n">module</span><span class="p">:</span> <span class="n">airflow</span><span class="o">.</span><span class="n">bin</span><span class="o">.</span><span class="n">cli</span>
	<span class="p">:</span><span class="n">func</span><span class="p">:</span> <span class="n">get_parser</span>
	<span class="p">:</span><span class="n">prog</span><span class="p">:</span> <span class="n">airflow</span>
	</pre></div>
	</div>
	</div>
	</div>


	</div>

	</div>


	<footer>

	<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

	<a href="scheduler.html" class="btn btn-neutral float-right" title="Scheduling & Triggers" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


	<a href="profiling.html" class="btn btn-neutral float-left" title="Data Profiling" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

	</div>


	<hr/>

	<div role="contentinfo">
	<p>

	</p>
	</div>
	Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
	<div class="footer">This page uses <a href="https://analytics.google.com/">
	Google Analytics</a> to collect statistics. You can disable it by blocking
	the JavaScript coming from www.google-analytics.com. Check our
	<a href="privacy_notice.html">Privacy Policy</a>
	for more details.
	</div>


	</footer>

	</div>
	</div>

	</section>

	</div>



	<script type="text/javascript">
	jQuery(function () {
	SphinxRtdTheme.Navigation.enable(true);
	});
	</script>




	<!-- Theme Analytics -->
	<script>
	(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]\|\|function(){
	(i[r].q=i[r].q\|\|[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
	m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
	})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

	ga('create', 'UA-140539454-1', 'auto');
	ga('send', 'pageview');
	</script>




	</body>
	</html>