Skip to content

Docs: fix stale CLI references and broken links across READMEs#6

Merged
rohanharikr merged 2 commits into
mainfrom
docs-fix-stale-cli-references
May 11, 2026
Merged

Docs: fix stale CLI references and broken links across READMEs#6
rohanharikr merged 2 commits into
mainfrom
docs-fix-stale-cli-references

Conversation

@rohanharikr
Copy link
Copy Markdown
Contributor

Summary

  • Root cause: @aauth/local-keys was split into a library (no bin) and @aauth/bootstrap (the CLI), but READMEs and bootstrap skill files still instructed users and AI agents to run npx @aauth/local-keys, which fails with "could not determine executable to run".
  • Sweep through all docs to fix the broken commands, add the three missing READMEs (bootstrap, fetch, hardware-keys), and correct spec links that pointed at this repo instead of dickhardt/AAuth.

Changes

  • Root README.md — added @aauth/bootstrap, @aauth/fetch, @aauth/hardware-keys to the packages table (bootstrap was missing entirely); replaced the broken npx @aauth/local-keys quick-start example with @aauth/bootstrap.
  • local-keys/README.md — rewritten as library-only. Obsolete CLI section removed; CLI users redirected to @aauth/bootstrap. API section retained.
  • bootstrap/skills/setup.md + 4 platform skills (github-pages, gitlab-pages, cloudflare-pages, netlify) — every npx @aauth/local-keys … replaced with npx @aauth/bootstrap …. These are loaded by AI agents during setup and were silently broken the same way.
  • mcp-agent, mcp-server, mcp-stdio, mcp-openclaw READMEs — fixed the "AAuth repo" link that pointed at this repo as the source of the protocol spec; now links aauth-dev/packages-js and dickhardt/AAuth separately.
  • New READMEsbootstrap/README.md, fetch/README.md, hardware-keys/README.md.
  • CLAUDE.md — fixed stale spec local path and casing.

Related spec-side cleanup: dickhardt/AAuth#27 updates the TypeScript implementation link to point at this repo.

Test plan

  • npx @aauth/bootstrap discover works (matches what the new docs claim)
  • npx @aauth/bootstrap show, npx @aauth/bootstrap skill setup work
  • All links in the modified READMEs resolve (aauth-dev/packages-js, dickhardt/AAuth, in-repo paths)
  • No remaining npx @aauth/local-keys references in markdown — grep -r "npx @aauth/local-keys" --include="*.md" returns nothing
  • Renders OK on GitHub (tables, code blocks, headings)

🤖 Generated with Claude Code

rohanharikr and others added 2 commits May 11, 2026 14:37
Root cause: @aauth/local-keys was split into a library (no bin) and
@aauth/bootstrap (the CLI), but several READMEs and bootstrap skill files
still instructed users and AI agents to run `npx @aauth/local-keys`, which
fails with "could not determine executable to run".

Changes:
- Root README: add bootstrap, fetch, hardware-keys to packages table;
  replace broken `npx @aauth/local-keys` example with @aauth/bootstrap;
  normalize spec link casing.
- local-keys/README.md: rewrite as library-only; remove obsolete CLI
  section; redirect CLI users to @aauth/bootstrap.
- bootstrap/skills/setup.md + 4 platform skills: replace every
  `npx @aauth/local-keys ...` with `npx @aauth/bootstrap ...`. These
  skill files are loaded by AI agents during setup and would fail the
  same way.
- mcp-agent, mcp-server, mcp-stdio, mcp-openclaw READMEs: fix "AAuth
  repo" link that pointed at packages-js as the spec source; now
  separately links packages-js and dickhardt/AAuth (the spec).
- Add bootstrap/README.md, fetch/README.md, hardware-keys/README.md
  (previously missing).
- CLAUDE.md: fix stale spec local path and casing.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Adds the missing resolved entries for the optional @aauth/hardware-keys-*
platform sub-packages (darwin-arm64, darwin-x64, linux-x64-gnu,
win32-x64-msvc). The optionalDependencies block in package-lock.json
listed them at 0.8.1 but the deep resolved nodes were stale from a prior
version, causing `npm ci` to fail in CI.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@rohanharikr rohanharikr merged commit 93afe2a into main May 11, 2026
6 checks passed
rohanharikr added a commit that referenced this pull request May 11, 2026
The default person server URL in docs was inconsistent: bootstrap/skills/setup.md
claimed `issuer.hello.coop`, fetch/skills/fetch.md used `person.hello-beta.net`,
and the new READMEs I added in #6 mistakenly used `hello.coop` (copied from a
stale example). Normalize everything to `person.hello-beta.net`.

Also add a note wherever the default is introduced (root README, bootstrap
README, setup.md skill) that the Hellō Beta PS resets data regularly and that
users can point at their own PS via `--person-server` / `--ps`.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@rohanharikr rohanharikr deleted the docs-fix-stale-cli-references branch May 11, 2026 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant