mirror of
https://github.com/sagiegurari/cargo-make
synced 2026-06-08 17:20:03 +00:00
sagie gur ari
23 lines
5.9 KiB
HTML
23 lines
5.9 KiB
HTML
<!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="API documentation for the Rust `cli` crate."><meta name="keywords" content="rust, rustlang, rust-lang, cli"><title>cli - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../cli/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate cli</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all cli's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'cli', ty: 'mod', relpath: '../'};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/cli/mod.rs.html#1-184' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>cli</a></span></h1><div class='docblock'><h1 id="cargo-make" class="section-header"><a href="#cargo-make">cargo-make</a></h1>
|
||
<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>
|
||
<h2 id="installation" class="section-header"><a href="#installation">Installation</a></h2>
|
||
<p>In order to install, just run the following command</p>
|
||
<pre><code class="language-sh">cargo install cargo-make
|
||
</code></pre>
|
||
<p>This will install cargo-make in your ~/.cargo/bin.<br>
|
||
Make sure to add ~/.cargo/bin directory to your PATH variable.</p>
|
||
<h1 id="contributing" class="section-header"><a href="#contributing">Contributing</a></h1>
|
||
<p>See <a href="https://github.com/sagiegurari/cargo-make/blob/master/.github/CONTRIBUTING.md">contributing guide</a></p>
|
||
<h1 id="license" class="section-header"><a href="#license">License</a></h1>
|
||
<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><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
||
<table><tr class='module-item'><td><a class="mod" href="types/index.html" title='cli::types mod'>types</a></td><td class='docblock-short'><p>types</p>
|
||
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table><tr class='module-item'><td><a class="fn" href="fn.run_cli.html" title='cli::run_cli fn'>run_cli</a></td><td class='docblock-short'><p>Handles the command line arguments and executes the runner.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "cli";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |