<!DOCTYPE HTML>
<html lang="en" class="sidebar-visible no-js light">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>Dyer-cli - CookBook of dyer</title>
<!-- Custom HTML head -->
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff" />
<link rel="icon" href="../favicon.svg">
<link rel="shortcut icon" href="../favicon.png">
<link rel="stylesheet" href="../css/variables.css">
<link rel="stylesheet" href="../css/general.css">
<link rel="stylesheet" href="../css/chrome.css">
<link rel="stylesheet" href="../css/print.css" media="print">
<!-- Fonts -->
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="../fonts/fonts.css">
<!-- Highlight.js Stylesheets -->
<link rel="stylesheet" href="../highlight.css">
<link rel="stylesheet" href="../tomorrow-night.css">
<link rel="stylesheet" href="../ayu-highlight.css">
<!-- Custom theme stylesheets -->
</head>
<body>
<!-- Provide site root to javascript -->
<script type="text/javascript">
var path_to_root = "../";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
</script>
<!-- Work around some values being stored in localStorage wrapped in quotes -->
<script type="text/javascript">
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>
<!-- Set the theme before any content is loaded, prevents flash -->
<script type="text/javascript">
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('light')
html.classList.add(theme);
html.classList.add('js');
</script>
<!-- Hide / unhide sidebar before it is displayed -->
<script type="text/javascript">
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
</script>
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<div class="sidebar-scrollbox">
<ol class="chapter"><li class="chapter-item expanded "><a href="../intro.html"><strong aria-hidden="true">1.</strong> Introduction</a></li><li class="chapter-item expanded "><a href="../dyer-cli/index.html" class="active"><strong aria-hidden="true">2.</strong> Dyer-cli</a></li><li class="chapter-item expanded "><a href="../actor/index.html"><strong aria-hidden="true">3.</strong> Actor</a></li><li class="chapter-item expanded "><a href="../middleware/index.html"><strong aria-hidden="true">4.</strong> Middleware</a></li><li class="chapter-item expanded "><a href="../database/index.html"><strong aria-hidden="true">5.</strong> Pipeline & Database Intergration</a></li><li class="chapter-item expanded "><a href="../affix/index.html"><strong aria-hidden="true">6.</strong> Affix</a></li><li class="chapter-item expanded "><a href="../attr/index.html"><strong aria-hidden="true">7.</strong> Attribute</a></li><li class="chapter-item expanded "><a href="../feedback/index.html"><strong aria-hidden="true">8.</strong> Problem & Feedback</a></li></ol>
</div>
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
</nav>
<div id="page-wrapper" class="page-wrapper">
<div class="page">
<div id="menu-bar-hover-placeholder"></div>
<div id="menu-bar" class="menu-bar sticky bordered">
<div class="left-buttons">
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i>
</button>
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
<i class="fa fa-paint-brush"></i>
</button>
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
</ul>
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
<i class="fa fa-search"></i>
</button>
</div>
<h1 class="menu-title">CookBook of dyer</h1>
<div class="right-buttons">
<a href="../print.html" title="Print this book" aria-label="Print this book">
<i id="print-button" class="fa fa-print"></i>
</a>
</div>
</div>
<div id="search-wrapper" class="hidden">
<form id="searchbar-outer" class="searchbar-outer">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
</form>
<div id="searchresults-outer" class="searchresults-outer hidden">
<div id="searchresults-header" class="searchresults-header"></div>
<ul id="searchresults">
</ul>
</div>
</div>
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
<script type="text/javascript">
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>
<div id="content" class="content">
<main>
<h1 id="dyer-cli"><a class="header" href="#dyer-cli">Dyer-cli</a></h1>
<p>Before stepping into the topic, <a href="https://crates.io/crates/dyer-cli">dyer-cli</a> is highly recommanded to be installed.
Dyer-cli is a handy tool for your easy and fast use of dyer, </p>
<h3 id="installation"><a class="header" href="#installation">Installation</a></h3>
<p><code>dyer-cli</code> is public crate, just run the following in the terminal,</p>
<pre><code class="language-bash">cargo install dyer-cli
</code></pre>
<p>once installed, type <code>dyer</code> in the terminal to check, if something like following it is successfully installed.</p>
<pre><code>Handy tool for dyer
USAGE:
dyer [subcommand] [options]
eg. dyer new myproject --debug
...
</code></pre>
<h3 id="create-project"><a class="header" href="#create-project">Create Project</a></h3>
<p>Dyer-cli generates a template that contains many useful instances and instructions
when using dyer with
following code:</p>
<pre><code class="language-bash">dyer new myproject
</code></pre>
<p>It will create a project called <code>myproject</code> and the files layout displays:</p>
<pre><code class="language-bash">|___Cargo.toml
|___Readme.md
|___data/
|___data/tasks/
|___src/
|___src/affix.rs
|___src/entity.rs
|___src/parser.rs
|___src/actor.rs
|___src/middleware.rs
|___src/pipeline.rs
</code></pre>
<h3 id="project-layout-and-its-role"><a class="header" href="#project-layout-and-its-role">Project layout and its role</a></h3>
<p>Main functionality of each file:</p>
<ul>
<li>the <code>affix.rs</code> serves as an actor to adjust and satisfy additional requirement</li>
<li>the <code>entity.rs</code> contains entities/data structure to be used/collected</li>
<li>the <code>parser.rs</code> contains functions that extract entities from response</li>
<li>the <code>actor.rs</code> contains initial when opening and final things to do when closing</li>
<li>the <code>middleware.rs</code> contains Some middlewares that process data at runtime</li>
<li>the <code>pipeline.rs</code> contains entities manipulation including data-storage, displsying and so on</li>
<li>the <code>lib.rs</code> exports all modules inside the directory, just do nothing here normally</li>
<li><code>Cargo.toml</code> is the basic configuration of the project</li>
<li><code>README.md</code> contains some instructions of the project</li>
<li><code>data/</code> place to store/load files of <code>App</code> when load-balancing and backup</li>
</ul>
<h3 id="basic-procedures"><a class="header" href="#basic-procedures">Basic Procedures</a></h3>
<p>Then it is your show time, basically there are simple example items(<code>function</code>, <code>enum</code>, <code>struct</code>)
in each file you can follow. After that check your code</p>
<pre><code class="language-bash">dyer check
</code></pre>
<p>if you run it the first time, dyer-cli will download the crates and then check the code.
if some warning happens such as <code>unused import</code> or <code>dead code</code> the command does a lot for you:</p>
<pre><code class="language-bash">dyer fix
</code></pre>
<p>A wraper of <code>cargo fix</code>, if some warning happens such as <code>unused import</code> or <code>dead code</code> the command does a lot for you. However it won't help if some errors occur, if so, you have to debug the code manually.</p>
<p>Edit <code>dyer.cfg</code> file in the root directory</p>
<p>the file contains some configurations of <code>ArgApp</code> that will update periodically, for more details see
[dyer.cfg Configuration]</p>
<p>When the program compiles, haha run it:</p>
<pre><code class="language-bash">dyer run
</code></pre>
</main>
<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<a rel="prev" href="../intro.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next" href="../actor/index.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
<div style="clear: both"></div>
</nav>
</div>
</div>
<nav class="nav-wide-wrapper" aria-label="Page navigation">
<a rel="prev" href="../intro.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next" href="../actor/index.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
</nav>
</div>
<!-- Livereload script (if served using the cli tool) -->
<script type="text/javascript">
var socket = new WebSocket("ws://localhost:3000/__livereload");
socket.onmessage = function (event) {
if (event.data === "reload") {
socket.close();
location.reload();
}
};
window.onbeforeunload = function() {
socket.close();
}
</script>
<script type="text/javascript">
window.playground_copyable = true;
</script>
<script src="../elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
<script src="../mark.min.js" type="text/javascript" charset="utf-8"></script>
<script src="../searcher.js" type="text/javascript" charset="utf-8"></script>
<script src="../clipboard.min.js" type="text/javascript" charset="utf-8"></script>
<script src="../highlight.js" type="text/javascript" charset="utf-8"></script>
<script src="../book.js" type="text/javascript" charset="utf-8"></script>
<!-- Custom JS scripts -->
</body>
</html>