<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="cargo-make"><title>cli - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-c579a84d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="cli" data-themes="" data-resource-suffix="" data-rustdoc-version="1.86.0-nightly (6067b3631 2025-01-17)" data-channel="nightly" data-search-js="search-ccb196c1.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../cli/index.html">cli</a><span class="version">0.37.24</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#cargo-make" title="cargo-make">cargo-make</a><ul><li><a href="#installation" title="Installation">Installation</a></li></ul></li><li><a href="#contributing" title="Contributing">Contributing</a></li><li><a href="#license" title="License">License</a></li></ul><h3><a href="#modules">Crate Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>cli</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/cli/mod.rs.html#1-85">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="cargo-make"><a class="doc-anchor" href="#cargo-make">§</a>cargo-make</h2>
<p>Rust task runner and build tool.<br>
The cargo-make task runner enables to define and configure sets of tasks and run them as a flow.<br>
A task is a command or a script to execute.<br>
Tasks can have dependencies which are also tasks that will be executed before the task itself.<br>
With a simple toml based configuration file, you can define a multi platform build script that can run build, test,
documentation generation, bench tests execution, security validations and more by running a single command.</p>
<h3 id="installation"><a class="doc-anchor" href="#installation">§</a>Installation</h3>
<p>In order to install, just run the following command</p>
<div class="example-wrap"><pre class="language-sh"><code>cargo install cargo-make</code></pre></div>
<p>This will install cargo-make in your ~/.cargo/bin.<br>
Make sure to add ~/.cargo/bin directory to your PATH variable.</p>
<h2 id="contributing"><a class="doc-anchor" href="#contributing">§</a>Contributing</h2>
<p>See <a href="https://github.com/sagiegurari/cargo-make/blob/master/.github/CONTRIBUTING.md">contributing guide</a></p>
<h2 id="license"><a class="doc-anchor" href="#license">§</a>License</h2>
<p>Developed by Sagie Gur-Ari and licensed under the
<a href="https://github.com/sagiegurari/cargo-make/blob/master/LICENSE">Apache 2</a> open source license.</p>
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="cli/index.html" title="mod cli::cli">cli</a></div><div class="desc docblock-short">cli</div></li><li><div class="item-name"><a class="mod" href="cli_commands/index.html" title="mod cli::cli_commands">cli_<wbr>commands</a></div><div class="desc docblock-short">cli_commands</div></li><li><div class="item-name"><a class="mod" href="cli_parser/index.html" title="mod cli::cli_parser">cli_<wbr>parser</a></div><div class="desc docblock-short">cli_parser</div></li><li><div class="item-name"><a class="mod" href="completion/index.html" title="mod cli::completion">completion</a></div></li><li><div class="item-name"><a class="mod" href="config/index.html" title="mod cli::config">config</a></div><div class="desc docblock-short">config</div></li><li><div class="item-name"><a class="mod" href="error/index.html" title="mod cli::error">error</a></div></li><li><div class="item-name"><a class="mod" href="logger/index.html" title="mod cli::logger">logger</a></div><div class="desc docblock-short">log</div></li><li><div class="item-name"><a class="mod" href="runner/index.html" title="mod cli::runner">runner</a></div><div class="desc docblock-short">runner</div></li><li><div class="item-name"><a class="mod" href="types/index.html" title="mod cli::types">types</a></div><div class="desc docblock-short">types</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.run_cli.html" title="fn cli::run_cli">run_cli</a></div><div class="desc docblock-short">Handles the command line arguments and executes the runner.</div></li></ul></section></div></main></body></html>