coliru

commit 6dd1aa242963d6dec3bfe6947c92ae3d2811aa13
parent fc172d952d479f42dec5761b2f53a909c1373686
Author: Asher Morgan <59518073+ashermorgan@users.noreply.github.com>
Date:   Thu,  4 Jul 2024 14:37:45 -0700

Update documentation

Diffstat:
M
README.md
 | 
16
+++++++++++-----
M
src/cli.rs
 | 
8
++++----
M
tests/basic.rs
 | 
2
+-

3 files changed, 16 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
@@ -2,20 +2,26 @@
 A minimal, flexible, dotfile installer
 
 ## Installation
-To install `coliru`, clone the repository and run `cargo install --path coliru/`
+To install coliru, clone the repository and run `cargo install --path coliru/`
 
-To uninstall `coliru`, run `cargo uninstall coliru`
+To uninstall coliru, run `cargo uninstall coliru`
 
 ## Usage
 Dotfiles are defined as a series of steps inside a manifest file that are
 executed conditionally based on tag rules. To install dotfiles, pass the
-manifest file and tag rules to `coliru`:
+manifest file and tag rules to coliru:
 
 ```
-coliru path/to/manifest.yml --tag-rules tag1 tag2,tag3 ^tag4
+coliru path/to/manifest.yml --tag-rules tag1 tag2 ^tag3
 ```
 
-Some helpful options include:
+Coliru can also install dotfiles on remote machines over SSH:
+
+```
+coliru path/to/manifest.yml --tag-rules tag1 tag2 ^tag3 --host user@hostname
+```
+
+Some other helpful options include:
 
 - `--help`, `-h`: Print full help information
 - `--dry-run`, `-n`: Do a trial run without any permanent changes
diff --git a/src/cli.rs b/src/cli.rs
@@ -14,6 +14,10 @@ struct Args {
     #[arg(short, long, num_args=0..)]
     pub tag_rules: Vec<String>,
 
+    /// Install dotfiles on another machine over SSH
+    #[arg(long, default_value="", hide_default_value=true)]
+    pub host: String,
+
     /// Interpret link commands as copy commands
     #[arg(short, long)]
     pub copy: bool,
@@ -21,10 +25,6 @@ struct Args {
     /// Do a trial run without any permanent changes
     #[arg(short = 'n', long)]
     pub dry_run: bool,
-
-    /// Install dotfiles on another machine via SSH
-    #[arg(long, default_value="", hide_default_value=true)]
-    pub host: String,
 }
 
 /// Runs the coliru CLI
diff --git a/tests/basic.rs b/tests/basic.rs
@@ -20,9 +20,9 @@ Arguments:
 
 Options:
   -t, --tag-rules [<TAG_RULES>...]  The set of tag rules to enforce
+      --host <HOST>                 Install dotfiles on another machine over SSH
   -c, --copy                        Interpret link commands as copy commands
   -n, --dry-run                     Do a trial run without any permanent changes
-      --host <HOST>                 Install dotfiles on another machine via SSH
   -h, --help                        Print help
   -V, --version                     Print version
 ");