docs(v2): rename db→eql CLI commands and move the CLI reference into /reference/cli#41
Closed
coderdan wants to merge 4 commits into
Closed
docs(v2): rename db→eql CLI commands and move the CLI reference into /reference/cli#41coderdan wants to merge 4 commits into
db→eql CLI commands and move the CLI reference into /reference/cli#41coderdan wants to merge 4 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
calvinbrewer
approved these changes
Jul 3, 2026
The CLI command moved to a dedicated `eql` command group; `db install` remains as a deprecated alias that prints a warning. Update all pages that reference the command and note the deprecated alias on the install page.
The stash CLI also renamed `db upgrade` → `eql upgrade` and `db status` → `eql status`; the old spellings remain as deprecated aliases.
coderdan
force-pushed
the
dan/rename-db-install-to-eql-install
branch
from
9254125 to
441241f
Compare
Ports the CipherStash CLI docs out of the legacy content/stack tree into the
V2 IA, following IA.md and the existing v2-redirects.mjs migration map:
content/stack/cipherstash/cli/{index,init,plan,impl,status,install,validate,push,api}
-> content/docs/reference/cli/
content/stack/cipherstash/cli/troubleshooting
-> content/docs/guides/troubleshooting/cli (troubleshooting is a guide,
not a reference — matches the redirect map and IA.md's guides entry)
- v2 facets added (type: reference / guide, components: [cli]) and an explicit
reference/cli meta.json preserving the Setup / Database / Reference grouping.
- All inbound links across the legacy tree repointed from /stack/cipherstash/cli*
to /reference/cli* and /guides/troubleshooting/cli (anchors preserved).
- Dropped duplicate body H1s to match the v2 reference-page convention; retitled
the troubleshooting page to "CLI troubleshooting" (its parent is "Troubleshooting").
- Redirect coverage already exists in v2-redirects.mjs (cli -> /reference/cli,
troubleshooting -> /guides/troubleshooting/cli, cli/:path* wildcard), so no
map change is needed.
validate-links (184 pages) and validate-redirects pass; all moved pages render.
Claude-Session: https://claude.ai/code/session_01CqDNqLSEEkCi7xAJFq7HJA
coderdan
changed the title
stash db install to stash eql installdb→eql CLI commands and move the CLI reference into /reference/cli
Per the content-model tagging rule (tag `eql` only when a page is about queryable-in-Postgres ciphertext): install, validate, push, and the CLI troubleshooting page deal with the EQL extension, so they carry [cli, eql] and will surface on the EQL hub. The general-workflow pages (init, plan, impl, status, api, index) stay [cli]. Claude-Session: https://claude.ai/code/session_01CqDNqLSEEkCi7xAJFq7HJA
Contributor
Author
|
Closing — superseded by the generator approach in #45.
Nothing lost: the legacy pages remain on v2, and the troubleshooting → Reopenable if the |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Targets
v2. Two related changes to the CLI docs.1.
stash db …→stash eql …The
stashCLI moved its EQL-extension commands into a dedicatedeqlgroup (cipherstash/stack#543):stash db installstash eql installstash db upgradestash eql upgradestash db statusstash eql statusThe old
dbspellings remain as deprecated aliases that print a warning. Every page that references these commands is updated, and the install page notes the alias.2. Move the CLI docs into the new IA
Per IA.md and the existing
v2-redirects.mjsmap, the CLI reference moves out of the legacycontent/stacktree:content/stack/cipherstash/cli/{index,init,plan,impl,status,install,validate,push,api}→content/docs/reference/cli/content/stack/cipherstash/cli/troubleshooting→content/docs/guides/troubleshooting/cli— troubleshooting is a guide, not a reference; this matches the redirect entry (/stack/cipherstash/cli/troubleshooting→/guides/troubleshooting/cli) and IA.md's separate "guides/troubleshooting/cli" item.Details:
type: reference/guide,components: [cli]); explicitreference/cli/meta.jsonpreserving the Setup / Database / Reference grouping./reference/cli*and/guides/troubleshooting/cli(anchors preserved); duplicate body H1s dropped.cli→/reference/cli,troubleshooting→ guides,cli/:path*wildcard) already exist.Test plan
bun run validate-links— clean (184 legacy pages)bun run validate-redirects— all legacy pages coveredNote: the rename half should land after (or with) the CLI release that ships the
eqlgroup.Heads-up: I split
troubleshootinginto/guides/troubleshooting/clito follow the redirect map rather than putting it under/reference/cli. Happy to fold it back into/reference/cliinstead (and update the one redirect entry) if you'd prefer everything under one section.https://claude.ai/code/session_01CqDNqLSEEkCi7xAJFq7HJA