@skrr-ai/cli 0.1.12 → 0.1.13

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.
@@ -10,7 +10,10 @@ const exec_oversky_1 = require("../../lib/exec-oversky");
10
10
  * quick install check.
11
11
  */
12
12
  class Daemon extends core_1.Command {
13
- static description = 'Manage the local skrr runtime. Wraps the `skrrd` binary.';
13
+ // "Wraps the `skrrd` binary" read, cold, as though you must already HAVE one —
14
+ // the opposite of what `skrr daemon install` does now that it fetches the
15
+ // signed release. Dogfooding 0.1.12 hit exactly that reading.
16
+ static description = 'Manage the local skrr runtime — install it, sign it in, and check on it.';
14
17
  static examples = [
15
18
  '<%= config.bin %> daemon install',
16
19
  '<%= config.bin %> daemon status',
package/dist/help.d.ts CHANGED
@@ -20,8 +20,27 @@ import { Help } from '@oclif/core';
20
20
  * before running it. The audience most likely to need the good message was the
21
21
  * audience reliably denied it.
22
22
  *
23
- * Only the not-found path is overridden. Real help output is untouched.
23
+ * It also puts a GETTING STARTED block at the top of `skrr --help`.
24
+ *
25
+ * Dogfooding 0.1.12 found the root help teaching neither of the two commands
26
+ * the release exists to deliver: ~50 topics in alphabetical order, with `login`
27
+ * between `list-tokens` and `logout`, and nothing saying a runtime is needed or
28
+ * that `skrr` can fetch one. The shortest path to a working machine was
29
+ * undiscoverable from inside the tool that provides it — findable only by
30
+ * someone who read the docs, which is what the two-command flow exists to make
31
+ * unnecessary.
32
+ *
33
+ * Printed BEFORE the standard output rather than appended, because the thing it
34
+ * competes with is a fifty-line topic list. A signpost below that is a signpost
35
+ * for people who already knew.
24
36
  */
25
37
  export default class SkrrHelp extends Help {
38
+ /**
39
+ * The two commands, before the topic list rather than after it.
40
+ *
41
+ * Deliberately not a tutorial: two lines, both runnable, in the order a new
42
+ * machine needs them.
43
+ */
44
+ protected showRootHelp(): Promise<void>;
26
45
  showHelp(argv: string[]): Promise<void>;
27
46
  }
package/dist/help.js CHANGED
@@ -23,9 +23,34 @@ const command_miss_1 = require("./lib/command-miss");
23
23
  * before running it. The audience most likely to need the good message was the
24
24
  * audience reliably denied it.
25
25
  *
26
- * Only the not-found path is overridden. Real help output is untouched.
26
+ * It also puts a GETTING STARTED block at the top of `skrr --help`.
27
+ *
28
+ * Dogfooding 0.1.12 found the root help teaching neither of the two commands
29
+ * the release exists to deliver: ~50 topics in alphabetical order, with `login`
30
+ * between `list-tokens` and `logout`, and nothing saying a runtime is needed or
31
+ * that `skrr` can fetch one. The shortest path to a working machine was
32
+ * undiscoverable from inside the tool that provides it — findable only by
33
+ * someone who read the docs, which is what the two-command flow exists to make
34
+ * unnecessary.
35
+ *
36
+ * Printed BEFORE the standard output rather than appended, because the thing it
37
+ * competes with is a fifty-line topic list. A signpost below that is a signpost
38
+ * for people who already knew.
27
39
  */
28
40
  class SkrrHelp extends core_1.Help {
41
+ /**
42
+ * The two commands, before the topic list rather than after it.
43
+ *
44
+ * Deliberately not a tutorial: two lines, both runnable, in the order a new
45
+ * machine needs them.
46
+ */
47
+ async showRootHelp() {
48
+ this.log('GETTING STARTED');
49
+ this.log(' skrr login Sign in. Offers to set this machine up if it has no runtime.');
50
+ this.log(' skrr daemon install Install the runtime by hand (fetches the signed release).');
51
+ this.log('');
52
+ return super.showRootHelp();
53
+ }
29
54
  async showHelp(argv) {
30
55
  // Mirror oclif's own id resolution: the topic separator is a space here, so
31
56
  // the id is the leading non-flag tokens joined with `:`.