docs(cli): align CLI reference with current implementation#31
Closed
docs(cli): align CLI reference with current implementation#31
Conversation
Rewrite the PostgresAI CLI reference to match the actual command tree in cli/bin/postgres-ai.ts: rename mon quickstart -> mon local-install, move show-key/remove-key under auth (drop top-level add-key in favour of `auth --set-key`), use hyphens for issues subcommands, and add the previously undocumented commands (prepare-db, unprepare-db, checkup, reports, set-default-project, set-storage-url, mcp install, issues create/update/update-comment/files/action-items, mon targets test, mon shell, mon clean, mon check, mon health, mon update, etc.).
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
1 participant
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.
Summary
The CLI reference at
/docs/reference-guides/postgresai-cli-referencehad drifted from the actual CLI inpostgres-ai/postgresai. This PR rewrites the page to match the current source (cli/bin/postgres-ai.ts).What was wrong
init <conn>(top-level)prepare-db [conn]add-key <key>(top-level)auth --set-key <key>show-key,remove-key(top-level)auth show-key/auth remove-keymon quickstartmon local-installmon targets add <conn> <name>(name required)nameis optionalissues post_comment(underscore)issues post-comment(hyphen)mcp install [client]listed but not described--storage-base-urlglobal optionNewly documented commands & flags
prepare-db(full option set, including Supabase mode and--print-sql/--verify/--reset-password)unprepare-dbcheckup(express mode +--upload/--project/--markdown)reports list | files | data(Console-side report browsing)set-default-project,set-storage-urlmon:health --wait,logs --follow/--tail,clean --keep-volumes,update,update-config,reset,check,shell,restart,targets testissues:create,update,update-comment,files upload,files download,action-items,view-action-item,create-action-item,update-action-item, plus the repeatable--attachflag and--json/--debugsemanticsmcp install(per-client behaviour)postgresaiandpgaibinary aliasesPGAI_STORAGE_BASE_URL,PGAI_MON_PASSWORD,SUPABASE_*Test plan
postgresai <command> --helpfor a couple of commands matches what the docs say./docs/postgresai-howtos/postgresai-clistill resolve.docs/postgresai-howtos/postgresai-cli.mdfor the same drift (left out of this PR to keep the diff focused).Generated by Claude Code