Skip to content

docs: a Command line page for sluiceway v0.45.0, its commands, their --json answers and exit codes - #23

Merged
robbeverhelst merged 1 commit into
mainfrom
cli-docs
Sep 25, 2026
Merged

robbeverhelst merged 1 commit into
mainfrom
cli-docs

Conversation

@robbeverhelst

Copy link
Copy Markdown
Contributor

Follows sluiceway v0.45.0 and adds a Command line page to the Hosted app section, at hosted-app/command-line/, between Using the app and What the app keeps.

What changes

  • The pin moves from v0.42.2 to v0.45.0: the submodule and the branch line of .gitmodules, as Renovate moves them. bun run pin and bun run release agree.
  • The page is read from the action's docs/command-line.md at the tag (pages.ts), like every other page from the action, so the links docs/init.md, docs/reference.md and record 0116 make to it land here and not on GitHub. It covers installing (npx, npm i -g, the five binaries with the SHA256SUMS check and the macOS xattr line), signing in with a token from the app's Tokens page, each command, exit codes for agents, and that every action counts as the person and shows in the audit log "via the command line".
  • Each command, by example, a section this repo adds (src/lib/command-line.ts): login, status, stack, tick (with the --yes refusal), rescan, settings and set, logout, and two failures, each with what it prints and its --json answer. The output is what the CLI at v0.45.0 prints against the fake app in the action's own tests, which the action holds to the app's OpenAPI document.
  • A test (test/command-line.test.ts) holds every app answer on the page to the schema the action's copy of that document (test/fixtures/app/openapi.json) names for it, checks that each failure's exit matches, and that every command the action's table lists has an example. A renamed field fails CI here.
  • Using the app links to the page from ticking and from the audit log.

Checked

  • bun run check (lint, tokens, pin, release, typecheck, build, 609 tests) under /docs, and build, tests and bun run links under https://docs.sluiceway.dev /: 32276 links on 148 pages, all land.
  • The page at 1280 px light and 390 px dark: no horizontal page scroll, long lines scroll inside their code block.
  • Lighthouse was not run.

For the owner

  • What the app keeps still says "No token of yours … so it cannot act as you". With personal tokens that sentence may need a word about what the app stores for a token. I left it alone because the app's side isn't in this repo.
  • Record 0116 says the app's API answered 404 on 2026-09-26. If it still does, this page describes commands that fail with exit 1 for now.
  • Record 0116 says the action's README links to the page once the site has it. The address is https://docs.sluiceway.dev/hosted-app/command-line/.

🤖 Generated with Claude Code

…--json answers and exit codes

Follow sluiceway v0.45.0. The page reads the action's docs/command-line.md,
so the links the action's own pages make to it land here, and adds one
example of each command with what it prints and its --json answer. A test
holds every example the app answers to the app's OpenAPI document at the
pinned tag. Using the app links to it from ticking and the audit log.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
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