Skip to content
This repository was archived by the owner on Oct 28, 2026. It is now read-only.

Remove dead SiteSitter link + add README badges - #2

Merged
AUTHENSOR merged 3 commits into
mainfrom
cleanup/presentation-fixes
Jun 12, 2026
Merged

AUTHENSOR merged 3 commits into
mainfrom
cleanup/presentation-fixes

Conversation

@AUTHENSOR

@AUTHENSOR AUTHENSOR commented Jun 12, 2026 •

Copy link
Copy Markdown
Owner

Light presentation touch-up for the README. No functional/code changes.

Changes

Original commit (dead link + badges)

  • Remove dead SiteSitter link. The "Authensor Safety Stack" list (README ~line 15) linked github.com/AUTHENSOR/SiteSitter, which is now private and returns a 404. Removed that one entry. Confirmed no other references to now-private repos remain.
  • Add a small badge row. Added node-engine (>=20) and license (MIT) badges. (The npm version badge originally added here has since been removed — see below.)

Follow-up commit (first-run legibility + badge fix)

  • Drop the npm version badge. It rendered a stale orange 1.0.0-beta.1 (the repo/README report beta.2, but only beta.1 is published to npm), which reads as "old/unmaintained" — the opposite of intent. Removed only that line; node + license badges kept (both verified accurate). Reversible once a beta.2 publish reconciles the versions.
  • Add a "First run (no control plane yet)" section. A newcomer with no control plane running previously had nothing telling them the fail-closed denials and connectivity warnings are expected. The new section points them at the zero-friction action and sets expectations:
    • safeclaw run --dry-run "Summarize README.md" works standalone and exits 0 once the wizard/init has saved a provider API key.
    • Write/exec/network actions fail closed by design until a control plane is up.
    • safeclaw doctor connectivity is an expected [WARN]; safeclaw health reporting "unreachable" and exiting non-zero is the expected fail-closed probe result.

Verification (run from a fresh clone of this branch)

  • safeclaw run --dry-run "..." (provider key set) → prints provider/policy simulation, exit 0.
  • safeclaw doctor (provider key set, no control plane) → connectivity [WARN], overall exit 0.
  • safeclaw health (no control plane) → "Control plane unreachable", exit 1 (fail-closed by design).
  • npm test → 446 tests. In a normal local environment all pass (control plane absent ⇒ connectivity check returns instantly). Note: in a network-restricted sandbox the 14 tests/doctor.test.js cases that call runDiagnostics() can exceed vitest's default 5000ms timeout because the connectivity probe to localhost:3000 hangs+retries instead of refusing instantly — that is an environment timing artifact, not a code change in this PR.

Notes for maintainer (out of scope for this presentation PR — raise separately)

  • npx authensor up is referenced but not published to npm (README, docs/install.md, src/doctor.js connectivity hint, etc.). It currently 404s, so the advertised path to stand up a control plane is a dead end. Fix needs a maintainer decision (publish authensor, or replace every reference with the real setup). Not guessed here.
  • safeclaw init --demo (docs/quickstart.md step 3) claims it provisions a demo Authensor token, but empirically prints "Auto-provisioning failed: fetch failed" and drops to a Google Form. Needs the demo provisioning made real, or the step rewritten. Left untouched.
  • Publish reconciliation: npm has @authensor/safeclaw@1.0.0-beta.1; repo/README are 1.0.0-beta.2. Publishing beta.2 would let the npm version badge be restored accurately.

Follow-up commit 4eb40c1 — control-plane setup is now real (no dead commands)

npx authensor up removed everywhere (it 404'd — the package never existed). Replaced with the real, public setup that serves the control plane on SafeClaw's default port (http://localhost:3000):

git clone https://github.com/AUTHENSOR/AUTHENSOR && cd AUTHENSOR && docker compose up -d

Verified against the flagship's main branch (has docker-compose.yml + a Quickstart mapping the control plane to :3000). Fixed in: README (×2), docs/install.md (×2), src/cli.js (×2), src/doctor.js, src/server.js, ui/dashboard/app.js.

safeclaw init --demo de-advertised — demo token auto-provisioning has no working backend (it degrades to a Google Form), so it's removed from the README command list, docs/quickstart.md, and docs/cli.md. The --demo flag and provisionDemo code path are kept (they fail gracefully); all tests unchanged.

Result: 446/446 tests pass, zero npx authensor up remains repo-wide, and a newcomer following any doc reaches a real, working control-plane setup.

John Kearney added 3 commits June 12, 2026 00:39
- Remove the SiteSitter entry from the Authensor Safety Stack list; the
  AUTHENSOR/SiteSitter repo is now private and the link 404s.
- Add a small badge row (npm version, node engine, MIT license). All three
  resolve against live data: npm reads the published version from the
  registry, node reads the engines field, license links to the LICENSE file.
Make the no-control-plane first run legible for newcomers:
- Add a 'First run (no control plane yet)' section: `safeclaw run
  --dry-run` works standalone and exits 0 once a provider key is set;
  write/exec/network actions fail closed by design; `doctor`
  connectivity is an expected [WARN]; `health` reporting unreachable
  and exiting non-zero is the expected fail-closed probe result.
- Remove only the npm version badge, which rendered a stale orange
  beta.1 (repo is beta.2, only beta.1 is published) and signaled
  'unmaintained'. Node + license badges kept (both accurate).

Docs-only; no code or CLI behavior changes. Behavior verified:
dry-run exits 0, doctor connectivity WARN (exit 0 with key set),
health exits non-zero when control plane unreachable.
…ead npx/--demo paths

Replace every 'npx authensor up' (the package never existed — E404) with the
real, public setup: clone AUTHENSOR/AUTHENSOR and run 'docker compose up -d'
(verified on main; serves http://localhost:3000, SafeClaw's default port).
Sites: README (x2), docs/install.md (x2), src/cli.js (x2), src/doctor.js,
src/server.js, ui/dashboard/app.js.

Stop advertising 'safeclaw init --demo' in user docs (demo auto-provisioning
has no working backend; it degrades to a Google Form). The --demo flag and
provisionDemo code path are kept (they fail gracefully) and tests are
unchanged; only the doc/UX promises are removed: README commands list,
docs/quickstart.md, docs/cli.md.

Tests: 446/446 pass. Zero 'npx authensor up' remains repo-wide.
@AUTHENSOR
AUTHENSOR merged commit 7eb53e4 into main Jun 12, 2026
0 of 4 checks passed
@AUTHENSOR
AUTHENSOR deleted the cleanup/presentation-fixes branch June 12, 2026 06:34
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant