Merge pull request #324 from hercules-ci/issue-323

Document attribute escaping
This commit is contained in:
Robert Hensing 2026-05-04 13:21:06 +01:00 committed by GitHub
commit a2a94cdb39
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 46 additions and 1 deletions

View file

@ -49,7 +49,16 @@ mkTransposedPerSystemModule {
type = types.lazyAttrsOf appType;
default = { };
description = ''
Programs runnable with nix run `<name>`.
An attribute set of programs runnable with [`nix run`](https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-run.html).
`nix run .#<name>` will run `apps.<name>`.
Attribute names containing special characters like `.` must be doubly quoted when used in installable arguments:
```bash
nix run '.#"example.com"'
```
Consider using `:` or `/` as separators instead (e.g., `foo:bar`) for better command-line usability.
'';
example = lib.literalExpression ''
{