@roarkanalytics/cli 0.67.1 → 0.68.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +22 -0
  3. package/completions.js +3 -3
  4. package/npm-shrinkwrap.json +2 -2
  5. package/package.json +1 -1
  6. package/runtime/commands/config-as-code.js +5 -23
  7. package/runtime/commands/get-started.d.ts +34 -0
  8. package/runtime/commands/get-started.js +350 -0
  9. package/runtime/config-bundle.d.ts +10 -0
  10. package/runtime/config-bundle.js +14 -3
  11. package/runtime/config-changes.d.ts +15 -0
  12. package/runtime/config-changes.js +32 -0
  13. package/runtime/get-started/account.d.ts +18 -0
  14. package/runtime/get-started/account.js +35 -0
  15. package/runtime/get-started/agent.d.ts +17 -0
  16. package/runtime/get-started/agent.js +116 -0
  17. package/runtime/get-started/answers.d.ts +15 -0
  18. package/runtime/get-started/answers.js +42 -0
  19. package/runtime/get-started/apply.d.ts +35 -0
  20. package/runtime/get-started/apply.js +54 -0
  21. package/runtime/get-started/existing.d.ts +15 -0
  22. package/runtime/get-started/existing.js +47 -0
  23. package/runtime/get-started/ladder.d.ts +37 -0
  24. package/runtime/get-started/ladder.js +69 -0
  25. package/runtime/get-started/module.d.ts +20 -0
  26. package/runtime/get-started/module.js +159 -0
  27. package/runtime/get-started/placeholder.d.ts +9 -0
  28. package/runtime/get-started/placeholder.js +36 -0
  29. package/runtime/get-started/prompt.d.ts +32 -0
  30. package/runtime/get-started/prompt.js +132 -0
  31. package/runtime/get-started/resources.d.ts +106 -0
  32. package/runtime/get-started/resources.js +184 -0
  33. package/runtime/get-started/run.d.ts +42 -0
  34. package/runtime/get-started/run.js +101 -0
  35. package/runtime/get-started/scaffold-only.d.ts +19 -0
  36. package/runtime/get-started/scaffold-only.js +43 -0
  37. package/runtime/get-started/scaffold.d.ts +15 -0
  38. package/runtime/get-started/scaffold.js +35 -0
  39. package/runtime/get-started/starter-metrics.d.ts +33 -0
  40. package/runtime/get-started/starter-metrics.js +104 -0
  41. package/runtime/get-started/steps.d.ts +33 -0
  42. package/runtime/get-started/steps.js +112 -0
  43. package/runtime/get-started/target.d.ts +47 -0
  44. package/runtime/get-started/target.js +81 -0
  45. package/runtime/get-started/types.d.ts +18 -0
  46. package/runtime/get-started/types.js +8 -0
  47. package/runtime/get-started/watch.d.ts +57 -0
  48. package/runtime/get-started/watch.js +103 -0
  49. package/runtime/program.js +5 -0
  50. package/version.d.ts +1 -1
  51. package/version.js +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.68.0](https://github.com/roarkhq/cli-roark-analytics/compare/v0.67.1...v0.68.0) (2026-11-05)
4
+
5
+
6
+ ### Features
7
+
8
+ * **cli:** `roark get-started`, a guided first simulation ([#143](https://github.com/roarkhq/cli-roark-analytics/issues/143)) ([a3290dd](https://github.com/roarkhq/cli-roark-analytics/commit/a3290dd1e3611ac22c6d4faac85f43223fb84e3b))
9
+
3
10
  ## [0.67.1](https://github.com/roarkhq/cli-roark-analytics/compare/v0.67.0...v0.67.1) (2026-11-05)
4
11
 
5
12
 
package/README.md CHANGED
@@ -40,6 +40,28 @@ a stored or environment credential to it. Pass `--allow-project-base-url` (or se
40
40
  `ROARK_ALLOW_PROJECT_BASE_URL`) once you have read the file, or `--token` to send a
41
41
  different credential.
42
42
 
43
+ ## Get started
44
+
45
+ ```sh
46
+ roark get-started
47
+ ```
48
+
49
+ Seven steps from an empty project to a graded simulation: the project you are in, the agent
50
+ under test, the caller that phones it, what the call is about, the metrics that grade it, the
51
+ saved run, and then the run itself. Each step writes one YAML file under `./roark` and the
52
+ directory is applied with `config apply`, so the setup is yours to commit, re-running it fills
53
+ in whatever is missing, and nothing is ever pruned.
54
+
55
+ It writes YAML by default, which needs nothing installed. In a project that has the SDK it
56
+ offers TypeScript instead: one `roark.config.ts` using the typed `define*` helpers, which
57
+ `config apply` finds by name.
58
+
59
+ ```sh
60
+ roark get-started --scaffold-only # write the config with placeholders; no questions, no API calls
61
+ roark get-started --no-run # set it all up, start the run yourself later
62
+ roark get-started --ts # TypeScript config instead of YAML
63
+ ```
64
+
43
65
  ## Usage
44
66
 
45
67
  Commands read noun before verb, and the verb is one of `list`, `get`, `create`,