skalpel 3.0.10 → 3.0.11
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/INSTALL.md +1 -1
- package/README.md +10 -0
- package/package.json +1 -1
package/INSTALL.md
CHANGED
|
@@ -47,7 +47,7 @@ The first-run flow assumes the user has obtained an `sk-skalpel-*` API key on We
|
|
|
47
47
|
|
|
48
48
|
This flow corresponds to Journey 1 — First launch, fresh authentication — in `SPEC.md`. That narrative describes what the user feels at each step; this document describes what the install machinery actually does.
|
|
49
49
|
|
|
50
|
-
If the user runs `skalpel` without first obtaining an API key, the TUI exits per spec §8.4 with a stderr pointer at `skalpel login`. The wizard above is the path for users who arrived through the post-signup install hub on Web; users with broken or missing auth state are returned to the shell.
|
|
50
|
+
If the user runs `skalpel` without first obtaining an API key, the TUI exits per spec §8.4 with a stderr pointer at `skalpel login`. The wizard above is the path for users who arrived through the post-signup install hub on Web; users with broken or missing auth state are returned to the shell. To sign out of an existing account on this machine, run `skalpel logout` from a shell — the CLI revokes the backend session (best-effort) and removes `auth.json` via `internal/auth.Delete`.
|
|
51
51
|
|
|
52
52
|
An alternative first-run flow uses `skalpel login` from the shell directly. That command runs a device-code flow against Cognito (per the Auth handoff section of the cross-surface contract) and writes `auth.json` without the user having to paste an API key. The two flows produce equivalent on-disk state; the API-key-paste flow is the one a user lands in when arriving from the Web post-signup install hub, and the device-code flow is the one a user runs when reauthenticating an account that has already been signed in on this machine before.
|
|
53
53
|
|
package/README.md
CHANGED
|
@@ -18,6 +18,16 @@ npm install -g skalpel
|
|
|
18
18
|
|
|
19
19
|
Both `skalpel` and `skalpeld` are placed on your `PATH`. For details on what gets installed where, per-OS service registration, updates, and uninstall, see [INSTALL.md](./INSTALL.md).
|
|
20
20
|
|
|
21
|
+
## Subcommands
|
|
22
|
+
|
|
23
|
+
`skalpel` accepts a small set of subcommands:
|
|
24
|
+
|
|
25
|
+
- `skalpel` — launch the Bubble Tea TUI (default).
|
|
26
|
+
- `skalpel login` — browser-loopback sign-in; writes `auth.json`.
|
|
27
|
+
- `skalpel logout` — revoke the active session (best-effort) and delete `auth.json`; supports `--yes` to skip the `[y/N]` confirm.
|
|
28
|
+
- `skalpel uninstall` — clean up skalpel state on this machine.
|
|
29
|
+
- `skalpel --version` / `skalpel --help` — utilities.
|
|
30
|
+
|
|
21
31
|
## Links
|
|
22
32
|
|
|
23
33
|
- Homepage: https://skalpel.ai
|