Add note about shell escaping quoted hostname or profile names

This commit is contained in:
notgne2 2021-01-24 18:24:31 -07:00
parent 3b08cef157
commit fc77473568
No known key found for this signature in database
GPG Key ID: BB661E172B42A7F8

View File

@ -14,7 +14,7 @@ A Simple, multi-profile Nix-flake deploy tool.
Basic usage: `deploy [options] <flake>`. Basic usage: `deploy [options] <flake>`.
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`: You can try out this tool easily with `nix run`:
- `nix run github:serokell/deploy-rs your-flake` - `nix run github:serokell/deploy-rs your-flake`