CyberShell/backy
1
1
Fork 0
Code Issues 10 Pull Requests Packages Projects 1 Releases 20 Wiki Activity

update docs and CI config

Browse Source
This commit is contained in:
Andrew Woodlee
2024-11-20 00:08:16 -06:00
parent 2daf2f130d
commit b7d1be495e
41 changed files with 4072 additions and 2650 deletions
Download Patch File Download Diff File Expand all files Collapse all files

207
docs/public/cli/index.html
View File

@ -3,24 +3,24 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0">
<meta name="generator" content="Hugo 0.110.0">
<meta name="generator" content="Relearn 5.11.2">
<meta name="generator" content="Hugo 0.135.0">
<meta name="generator" content="Relearn 5.16.2">
<meta name="description" content="">
<title>CLI - A tool for commands</title>
<link href="/cli/index.xml" rel="alternate" type="application/rss+xml" title="CLI - A tool for commands">
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
<link href="/css/fontawesome-all.min.css?1676866111" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fontawesome-all.min.css?1676866111" rel="stylesheet"></noscript>
<link href="/css/auto-complete.css?1676866111" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/auto-complete.css?1676866111" rel="stylesheet"></noscript>
<link href="/css/perfect-scrollbar.min.css?1676866111" rel="stylesheet">
<link href="/css/nucleus.css?1676866111" rel="stylesheet">
<link href="/css/fonts.css?1676866111" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fonts.css?1676866111" rel="stylesheet"></noscript>
<link href="/css/theme.css?1676866111" rel="stylesheet">
<link href="/css/theme-auto.css?1676866111" rel="stylesheet" id="variant-style">
<link href="/css/ie.css?1676866111" rel="stylesheet">
<link href="/css/variant.css?1676866111" rel="stylesheet">
<link href="/css/print.css?1676866111" rel="stylesheet" media="print">
<script src="/js/url.js?1676866111"></script>
<script src="/js/variant.js?1676866111"></script>
<link href="/css/fontawesome-all.min.css?1732082585" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fontawesome-all.min.css?1732082585" rel="stylesheet"></noscript>
<link href="/css/nucleus.css?1732082585" rel="stylesheet">
<link href="/css/auto-complete.css?1732082585" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/auto-complete.css?1732082585" rel="stylesheet"></noscript>
<link href="/css/perfect-scrollbar.min.css?1732082585" rel="stylesheet">
<link href="/css/fonts.css?1732082585" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fonts.css?1732082585" rel="stylesheet"></noscript>
<link href="/css/theme.css?1732082585" rel="stylesheet">
<link href="/css/theme-auto.css?1732082585" rel="stylesheet" id="variant-style">
<link href="/css/variant.css?1732082585" rel="stylesheet">
<link href="/css/print.css?1732082585" rel="stylesheet" media="print">
<link href="/css/ie.css?1732082585" rel="stylesheet">
<script src="/js/url.js?1732082585"></script>
<script src="/js/variant.js?1732082585"></script>
<script>
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
@ -43,7 +43,7 @@
<div id="body" class="default-animation">
<div id="sidebar-overlay"></div>
<div id="toc-overlay"></div>
<nav id="topbar" class="highlightable" dir="ltr">
<nav id="topbar" class="highlightable">
<div>
<div id="breadcrumbs">
<span id="sidebar-toggle-span">
@ -55,17 +55,17 @@
</span>
</div>
<div class="default-animation progress">
<div class="toc-wrapper" dir="ltr">
<nav id="TableOfContents">
<div class="toc-wrapper"><nav id="TableOfContents">
<ul>
<li><a href="#subcommands">Subcommands</a>
<ul>
<li><a href="#backy-backup">backy backup</a></li>
<li><a href="#backy-exec">backy exec</a></li>
<li><a href="#backy-cron">backy cron</a></li>
<li><a href="#backy-version">backy version</a></li>
</ul>
</li>
<li><a href="#backy">Backy</a></li>
</ul>
<ul>
<li><a href="#backup">backup</a></li>
<li><a href="#cron">cron</a></li>
<li><a href="#exec">exec</a></li>
<li><a href="#version">version</a></li>
<li><a href="#list">list</a></li>
</ul>
</nav>
</div>
@ -74,19 +74,40 @@
</nav>
<main id="body-inner" class="highlightable default" tabindex="-1">
<div class="flex-block-wrapper">
<div id="head-tags">
</div>
<article class="default">
<header class="headline">
</header>
<h1 id="cli">CLI</h1>
<p>This page lists documentation for the CLI.</p>
<h2 id="subcommands">Subcommands</h2>
<h3 id="backy-backup">backy backup</h3>
<pre tabindex="0"><code>Backup executes commands defined in config file.
Use the --lists flag to execute the specified commands. If not specified, all lists will be executed.
<h2 id="backy">Backy</h2>
<pre tabindex="0"><code>Backy is a command-line application useful for configuring backups, or any commands run in sequence.
Usage:
backy backup [--lists=list1,list2] [flags]
backy [command]
Available Commands:
backup Runs commands defined in config file.
completion Generate the autocompletion script for the specified shell
cron Starts a scheduler that runs lists defined in config file.
exec Runs commands defined in config file in order given.
help Help about any command
list Lists commands, lists, or hosts defined in config file.
version Prints the version and exits
Flags:
-f, --config string config file to read from
-h, --help help for backy
-v, --verbose Sets verbose level
Use &#34;backy [command] --help&#34; for more information about a command.
</code></pre><h1 id="subcommands">Subcommands</h1>
<h2 id="backup">backup</h2>
<pre tabindex="0"><code>Backup executes commands defined in config file.
Use the --lists or -l flag to execute the specified lists. If not flag is not given, all lists will be executed.
Usage:
backy backup [--lists=list1,list2,... | -l list1, list2,...] [flags]
Flags:
-h, --help help for backup
@ -95,19 +116,7 @@ Flags:
Global Flags:
-f, --config string config file to read from
-v, --verbose Sets verbose level
</code></pre><h3 id="backy-exec">backy exec</h3>
<pre tabindex="0"><code>Exec executes commands defined in config file.
Usage:
backy exec command ... [flags]
Flags:
-h, --help help for exec
Global Flags:
-f, --config string config file to read from
-v, --verbose Sets verbose level
</code></pre><h3 id="backy-cron">backy cron</h3>
</code></pre><h2 id="cron">cron</h2>
<pre tabindex="0"><code>Cron starts a scheduler that executes command lists at the time defined in config file.
Usage:
@ -119,22 +128,56 @@ Flags:
Global Flags:
-f, --config string config file to read from
-v, --verbose Sets verbose level
</code></pre><h3 id="backy-version">backy version</h3>
<pre tabindex="0"><code>Prints the version and exits.
</code></pre><h2 id="exec">exec</h2>
<pre tabindex="0"><code>Exec executes commands defined in config file in order given.
Usage:
backy exec command ... [flags]
Flags:
-h, --help help for exec
Global Flags:
-f, --config string config file to read from
-v, --verbose Sets verbose level
</code></pre><h2 id="version">version</h2>
<pre tabindex="0"><code>Prints the version and exits. No arguments just prints the version number only.
Usage:
backy version [flags]
Flags:
-h, --help help for version
-n, --num Output the version number only.
-V, --vpre Output the version with v prefixed.
Global Flags:
-f, --config string config file to read from
-v, --verbose Sets verbose level
</code></pre><h2 id="list">list</h2>
<pre tabindex="0"><code>Backup lists commands or groups defined in config file.
Use the --lists or -l flag to list the specified lists. If not flag is not given, all lists will be executed.
Usage:
backy list [--list=list1,list2,... | -l list1, list2,...] [ -cmd cmd1 cmd2 cmd3...] [flags]
Flags:
-c, --cmds strings Accepts comma-separated names of commands to list.
-h, --help help for list
-l, --lists strings Accepts comma-separated names of command lists to list.
Global Flags:
-f, --config string config file to read from
-v, --verbose Sets verbose level
</code></pre>
<footer class="footline">
</footer>
</article>
</div>
</main>
</div>
<aside id="sidebar" class="default-animation" dir="ltr">
<aside id="sidebar" class="default-animation">
<div id="header-wrapper" class="default-animation">
<div id="header" class="default-animation">
<style>
@ -193,27 +236,28 @@ Flags:
<script>
var contentLangs=['en'];
</script>
<script src="/js/auto-complete.js?1676866111" defer></script>
<script src="/js/lunr/lunr.min.js?1676866111" defer></script>
<script src="/js/lunr/lunr.stemmer.support.min.js?1676866111" defer></script>
<script src="/js/lunr/lunr.multi.min.js?1676866111" defer></script>
<script src="/js/lunr/lunr.en.min.js?1676866111" defer></script>
<script src="/js/search.js?1676866111" defer></script>
<script src="/js/auto-complete.js?1732082585" defer></script>
<script src="/js/lunr/lunr.min.js?1732082585" defer></script>
<script src="/js/lunr/lunr.stemmer.support.min.js?1732082585" defer></script>
<script src="/js/lunr/lunr.multi.min.js?1732082585" defer></script>
<script src="/js/lunr/lunr.en.min.js?1732082585" defer></script>
<script src="/js/search.js?1732082585" defer></script>
</div>
<div id="content-wrapper" class="highlightable">
<ul class="topics collapsible-menu">
<li data-nav-id="/getting-started/index.html" class="dd-item"><input type="checkbox" id="section-c727fab97b4d77e5b28ce8c448fb9000" aria-controls="subsections-c727fab97b4d77e5b28ce8c448fb9000" class="toggle"><label class="a11y-only toggle" for="section-c727fab97b4d77e5b28ce8c448fb9000" >Submenu Getting started</label><a href="/getting-started/index.html">Getting started</a><ul id="subsections-c727fab97b4d77e5b28ce8c448fb9000">
<li data-nav-id="/getting-started/install/index.html" class="dd-item"><a href="/getting-started/install/index.html">Install Backy</a></li>
<li data-nav-id="/getting-started/config/index.html" class="dd-item"><a href="/getting-started/config/index.html">Config File Definitions</a></li></ul></li>
<li data-nav-id="/config/index.html" class="dd-item"><input type="checkbox" id="section-98a8c13bcd8ebb34cfcbafd00ee6590b" aria-controls="subsections-98a8c13bcd8ebb34cfcbafd00ee6590b" class="toggle"><label class="a11y-only toggle" for="section-98a8c13bcd8ebb34cfcbafd00ee6590b" >Submenu Configuring Backy</label><a href="/config/index.html">Configuring Backy</a><ul id="subsections-98a8c13bcd8ebb34cfcbafd00ee6590b">
<li data-nav-id="/config/command-lists/index.html" class="dd-item"><a href="/config/command-lists/index.html">Command Lists</a></li>
<li data-nav-id="/config/commands/index.html" class="dd-item"><a href="/config/commands/index.html">Commands</a></li>
<li data-nav-id="/config/notifications/index.html" class="dd-item"><a href="/config/notifications/index.html">Notifications</a></li></ul></li>
<li data-nav-id="/cli/index.html" class="dd-item active"><a href="/cli/index.html">CLI</a></li>
<li data-nav-id="/repositories/index.html" class="dd-item"><a href="/repositories/index.html">Repositories</a></li>
<ul class="topics enlarge morespace collapsible-menu">
<li data-nav-id="/getting-started/index.html" class=""><input type="checkbox" id="section-ffe9773a38b1e1cbc000aa49823cb86b" aria-controls="subsections-ffe9773a38b1e1cbc000aa49823cb86b"><label for="section-ffe9773a38b1e1cbc000aa49823cb86b"><i class="fas fa-chevron-down"></i><i class="fas fa-chevron-right"></i><span class="a11y-only">Submenu Getting started</span></label><a class="padding" href="/getting-started/index.html">Getting started</a><ul id="subsections-ffe9773a38b1e1cbc000aa49823cb86b" class="morespace collapsible-menu">
<li data-nav-id="/getting-started/install/index.html" class=""><a class="padding" href="/getting-started/install/index.html">Install Backy</a></li>
<li data-nav-id="/getting-started/config/index.html" class=""><a class="padding" href="/getting-started/config/index.html">Config File Definitions</a></li></ul></li>
<li data-nav-id="/config/index.html" class=""><input type="checkbox" id="section-05a1934784c32ed5016a6c9b2dd9e019" aria-controls="subsections-05a1934784c32ed5016a6c9b2dd9e019"><label for="section-05a1934784c32ed5016a6c9b2dd9e019"><i class="fas fa-chevron-down"></i><i class="fas fa-chevron-right"></i><span class="a11y-only">Submenu Configuring Backy</span></label><a class="padding" href="/config/index.html">Configuring Backy</a><ul id="subsections-05a1934784c32ed5016a6c9b2dd9e019" class="morespace collapsible-menu">
<li data-nav-id="/config/commands/index.html" class=""><a class="padding" href="/config/commands/index.html">Commands</a></li>
<li data-nav-id="/config/command-lists/index.html" class=""><a class="padding" href="/config/command-lists/index.html">Command Lists</a></li>
<li data-nav-id="/config/notifications/index.html" class=""><a class="padding" href="/config/notifications/index.html">Notifications</a></li>
<li data-nav-id="/config/vault/index.html" class=""><a class="padding" href="/config/vault/index.html">Vault</a></li></ul></li>
<li data-nav-id="/cli/index.html" class="active"><a class="padding" href="/cli/index.html">CLI</a></li>
<li data-nav-id="/repositories/index.html" class=""><a class="padding" href="/repositories/index.html">Repositories</a></li>
</ul>
<div class="footermargin footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter"></div>
<hr class="default-animation footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter">
<div class="padding footermargin footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter"></div>
<hr class="padding default-animation footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter">
<div id="prefooter" class="footerLangSwitch footerVariantSwitch footerVisitedLinks">
<ul>
<li id="select-language-container" class="footerLangSwitch">
@ -223,6 +267,7 @@ Flags:
<div class="select-style">
<label class="a11y-only" for="select-language">Language</label>
<select id="select-language" onchange="location = baseUri + this.value;">
<option lang="en" id="en" value="/cli/index.html" selected></option>
</select>
</div>
<div class="select-clear"></div>
@ -242,7 +287,7 @@ Flags:
</div>
<script>window.variants && variants.markSelectedVariant();</script>
</li>
<li class="footerVisitedLinks"><button class="padding" onclick="clearHistory();"><i class="fas fa-history fa-fw"></i> Clear History</button></li>
<li class="footerVisitedLinks"><button class="padding" onclick="clearHistory();"><i class="fas fa-history fa-fw"></i><span>&nbsp;</span>Clear History</button></li>
</ul>
</div>
<div id="footer" class="footerFooter showFooter">
@ -250,8 +295,8 @@ Flags:
</div>
</div>
</aside>
<script src="/js/clipboard.min.js?1676866111" defer></script>
<script src="/js/perfect-scrollbar.min.js?1676866111" defer></script>
<script src="/js/clipboard.min.js?1732082585" defer></script>
<script src="/js/perfect-scrollbar.min.js?1732082585" defer></script>
<script>
function useMathJax( config ){
if( !Object.assign ){
@ -281,23 +326,19 @@ Flags:
useMathJax( JSON.parse("{}") );
</script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<script src="/js/d3/d3-color.min.js?1676866111" defer></script>
<script src="/js/d3/d3-dispatch.min.js?1676866111" defer></script>
<script src="/js/d3/d3-drag.min.js?1676866111" defer></script>
<script src="/js/d3/d3-ease.min.js?1676866111" defer></script>
<script src="/js/d3/d3-interpolate.min.js?1676866111" defer></script>
<script src="/js/d3/d3-selection.min.js?1676866111" defer></script>
<script src="/js/d3/d3-timer.min.js?1676866111" defer></script>
<script src="/js/d3/d3-transition.min.js?1676866111" defer></script>
<script src="/js/d3/d3-zoom.min.js?1676866111" defer></script>
<script src="/js/d3/d3-color.min.js?1732082585" defer></script>
<script src="/js/d3/d3-dispatch.min.js?1732082585" defer></script>
<script src="/js/d3/d3-drag.min.js?1732082585" defer></script>
<script src="/js/d3/d3-ease.min.js?1732082585" defer></script>
<script src="/js/d3/d3-interpolate.min.js?1732082585" defer></script>
<script src="/js/d3/d3-selection.min.js?1732082585" defer></script>
<script src="/js/d3/d3-timer.min.js?1732082585" defer></script>
<script src="/js/d3/d3-transition.min.js?1732082585" defer></script>
<script src="/js/d3/d3-zoom.min.js?1732082585" defer></script>
<script src="https://unpkg.com/mermaid/dist/mermaid.min.js" defer></script>
<script>
window.themeUseMermaid = JSON.parse("{ \"theme\": \"default\" }");
</script>
<script src="https://unpkg.com/rapidoc/dist/rapidoc-min.js" defer></script>
<script>
window.themeUseSwagger = JSON.parse("{ \"theme\": \"light\" }");
</script>
<script src="/js/theme.js?1676866111" defer></script>
<script src="/js/theme.js?1732082585" defer></script>
</body>
</html>