From 3b08cef157aeca944245d73e92e688438448bfa8 Mon Sep 17 00:00:00 2001 From: notgne2 Date: Fri, 1 Jan 2021 19:35:22 -0700 Subject: Document quotating profile or hostnames with a `.` in CLI (closes #10) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index fcaf6e2..335fcd0 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ A Simple, multi-profile Nix-flake deploy tool. Basic usage: `deploy [options] `. -The given flake can be just a source `my-flake`, or optionally specify the node to deploy `my-flake#my-node`, or specify a profile too `my-flake#my-node.my-profile`. +The given flake can be just a source `my-flake`, or optionally specify the node to deploy `my-flake#my-node`, or specify a profile too `my-flake#my-node.my-profile`. If your profile or node name has a `.` in it, simply wrap it in quotes, for example `my-flake."myserver.com".system`. You can try out this tool easily with `nix run`: - `nix run github:serokell/deploy-rs your-flake` -- cgit v1.2.3 From fc77473568cfcb86245c4cf45b59d7b86e049a5c Mon Sep 17 00:00:00 2001 From: notgne2 Date: Sun, 24 Jan 2021 18:24:31 -0700 Subject: Add note about shell escaping quoted hostname or profile names --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 335fcd0..34f92c3 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ A Simple, multi-profile Nix-flake deploy tool. Basic usage: `deploy [options] `. -The given flake can be just a source `my-flake`, or optionally specify the node to deploy `my-flake#my-node`, or specify a profile too `my-flake#my-node.my-profile`. If your profile or node name has a `.` in it, simply wrap it in quotes, for example `my-flake."myserver.com".system`. +The given flake can be just a source `my-flake`, or optionally specify the node to deploy `my-flake#my-node`, or specify a profile too `my-flake#my-node.my-profile`. If your profile or node name has a `.` in it, simply wrap it in quotes, and the flake path in quotes (to avoid shell escaping), for example `'my-flake."myserver.com".system'`. You can try out this tool easily with `nix run`: - `nix run github:serokell/deploy-rs your-flake` -- cgit v1.2.3