qrlkit 0.12.1 → 0.14.0

package/README.md

@@ -360,6 +360,46 @@ qrlkit greet Hey
 
 Supported shells: `bash`, `sh`, and `zsh`.
 
+### Arguments
+
+Prompt for text or pick one allowed value.
+
+```toml
+[greet]
+args = [
+  { name = "name" },
+  { name = "greeting", enum = ["Hello", "Hi", "Hey"] },
+]
+run = 'printf "%s, %s!\n" "$2" "$1"'
+```
+
+```sh
+greet          # Prompt for both
+greet Ada      # Choose a greeting
+greet Ada Hi   # Use both directly
+```
+
+Scripts use `"$1"`, `"$2"`, etc. in `args` order. URLs and paths use `{name}`.
+Reuse a list with `enum = { ref = "shared.greetings" }`.
+
+Select several values with `multiple = true` and a nonempty `join` separator.
+
+```toml
+[dashboard]
+args = [
+  { name = "regions", enum = ["eu", "us", "asia"], multiple = true, join = "," },
+]
+url = "https://dashboard.example.com/?regions={regions}"
+```
+
+```sh
+dashboard           # Space toggles, Enter confirms at least one
+dashboard eu,asia   # Supply the joined value directly
+```
+
+Interactive selections follow list order and become one value: `eu,asia`.
+Values are URL-encoded in URLs. Choices must not conflict with the separator.
+
 ### Shared values
 
 Put shared values in any config and register it with `qrlkit add`.
@@ -392,42 +432,56 @@ NAME = "{shared.name}"
 
 ### Composition
 
-Reference another resource's target without opening it.
+`qrlkit` offers a few ways to compose one QRL from multiple others. First principle is that everything is callable and referenceable if its not `hidden = true`.
 
-```toml
-# Reference another QRL's value or URL
-url = "{project.home}/issues"
+**One QRL calls another**
 ```
+[qrl-1]
+url = "https:/..."
 
-```toml
-# Use a script's output
-[branch]
-run = "git branch --show-current"
+[qrl-1.qrl-2]
+run = 'echo "sub/path"'
 
-[compare]
-url = "{project.home}/compare/main...{branch}"
+[qrl-3]
+url = "{qrl-1}/{qrl-1.qrl-2}"
 ```
+Not here its possible to chain keys with a dot like `objs.fruits.apples`. 
+
+**Group static fields and ref them**
 
 ```toml
-# Look up a value using one selector
-[project]
-environment = ["staging", "production"]
+[args]
+floors = ["1", "2", "3"]
+apartment = ["a", "b", "c"]
 
-[open]
-url = "https://{hosts[project.environment]}.example.com"
+[ding]
+url = "https://ding-a.door/{floor}/{apartment}"
+args = [
+  { name = "floor", enum = { ref = "args.floors" } },
+  { name = "apartment", enum = { ref = "args.apartment" } },
+]
 ```
 
+**Dynamically look up keys**
+
 ```toml
-# Walk a nested mapping using multiple selectors
-[project]
-name = ["api", "web"]
-environment = ["staging", "production"]
+[args]
+project = ["docs", "status"]
+environment = ["staging", "prod"]
+
+[domains.docs]
+staging = "docs-staging.example.com"
+prod = "docs.example.com"
+
+[domains.status]
+staging = "status-staging.example.com"
+prod = "status.example.com"
 
-[open]
-url = "https://{hosts[project.name, project.environment]}.example.com"
+[site]
+url = "https://{domains[args.project, args.environment]}"
 ```
 
-Missing references and circular dependencies are errors.
+Here `domains[args.project, args.environment]` resolves by first prompting for project (`docs` or `status`) and then use that to select either `[domains.docs]` or `[domains.status]`  and prompt for a environment (`staging` or `prod`). 
 
 ### Hints and hidden groups
 

package/package.json

@@ -9,10 +9,10 @@
     "README.md"
   ],
   "optionalDependencies": {
-    "qrlkit-darwin-arm64": "0.12.1",
-    "qrlkit-darwin-x64": "0.12.1",
-    "qrlkit-linux-arm64": "0.12.1",
-    "qrlkit-linux-x64": "0.12.1"
+    "qrlkit-darwin-arm64": "0.14.0",
+    "qrlkit-darwin-x64": "0.14.0",
+    "qrlkit-linux-arm64": "0.14.0",
+    "qrlkit-linux-x64": "0.14.0"
   },
   "os": [
     "linux",
@@ -34,5 +34,5 @@
   "bugs": {
     "url": "https://github.com/qrlkit/qrlkit-rs/issues"
   },
-  "version": "0.12.1"
+  "version": "0.14.0"
 }