superbee 0.4.0 → 0.4.1

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "superbee",
3
- "version": "0.4.0",
3
+ "version": "0.4.1",
4
4
  "type": "module",
5
5
  "description": "Agent-facing Superbee CLI for reading and writing local OKF knowledge bundles: context notes, docs, cross-links, and live bundle Views.",
6
6
  "keywords": [
@@ -74,11 +74,34 @@ Only run it when the person asks for the move.
74
74
 
75
75
  ## Sign-in: relay the link, then retry
76
76
 
77
- Hosted commands start sign-in by themselves. When a command returns `AUTH_REQUIRED` (exit 4):
78
-
79
- 1. Give the person `details.sign_in_url` and `details.user_code` exactly as returned.
80
- 2. Wait until they say they have confirmed.
81
- 3. Run the same command again (`details.resume`). It finishes sign-in and continues.
77
+ First run on a machine, in order:
78
+
79
+ 1. `superbee whoami`. It exits 0 either way. `signed_in: false` with `status: not_signed_in` names
80
+ the command to run; `status: waiting_for_confirmation` lists a sign-in already started, with its
81
+ link. The CLI never picks a host on its own; if the person may use a host other than the one
82
+ named, ask them which.
83
+ 2. `superbee login --host <url>`. It returns exit 4 while it waits for the person (below).
84
+ 3. Once they confirm, re-run the same `login`. It reports `signed_in`, and later hosted reads use
85
+ that host until another is named with `--host`. Writes such as `checkout` and `publish` need
86
+ `--host` once you are signed in to more than one host.
87
+
88
+ Exit 4 (`AUTH_REQUIRED`) means sign-in is needed. It is not a failure, so do not report it as one.
89
+ Read `details.status`:
90
+
91
+ - `waiting_for_confirmation`: a sign-in has started and is waiting for the person.
92
+ 1. Give the person `details.sign_in_url` and `details.user_code` exactly as returned.
93
+ 2. Wait until they say they have confirmed.
94
+ 3. Run the same command again (`details.resume`). It finishes sign-in and continues.
95
+ - `not_signed_in`: no host is known on this machine yet. Run `details.sign_in_command` (or the same
96
+ `login` with the person's host), then re-run the original command.
97
+ - No `status` (for example a session that ended during a sync): run the `login` command in `help`,
98
+ relay the link it returns as above, then re-run the original command.
99
+
100
+ A `RUNTIME` error with `details.reason: state_dir_not_writable` means this process may not write
101
+ Superbee's private state directory, `~/.superbee-state`. The usual cause is an agent sandbox that
102
+ allows writes only inside the workspace. Ask the person to allow writes to that directory (or to
103
+ approve running the command outside the sandbox), then re-run it. There is no override for the
104
+ directory's location.
82
105
 
83
106
  Never ask for a password, token or code the person did not see in their browser.
84
107
  `superbee setup hosted` signs in and records the default hosted workspace in one step. If the