Skip to content

docs(cli): add comprehensive CLI reference README (#2329) - #2364

Merged
rafal-hawrylak merged 1 commit into
mainfrom
docs/cli-readme
Oct 9, 2026
Merged

rafal-hawrylak merged 1 commit into
mainfrom
docs/cli-readme

Conversation

@rafal-hawrylak

Copy link
Copy Markdown
Collaborator

No description provided.

Comment thread cli/README.md Resolved
Comment thread cli/README.md Resolved
Comment thread cli/README.md Resolved
Comment thread cli/README.md Resolved
Comment thread cli/README.md Resolved
Comment thread cli/README.md Resolved
Comment thread cli/README.md Resolved
Comment thread cli/README.md Resolved
Comment thread cli/README.md Resolved

@apilaskowski apilaskowski left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly some small discussion points, overall I am happy with this one.

@apilaskowski

Copy link
Copy Markdown
Collaborator

I see that marking specific part of a line is not working perfectly, but I updated all points that are not obvious. Let me know if some comments needs explanation or reanchoring.

@apilaskowski

Copy link
Copy Markdown
Collaborator

After your last amended commit it lost track of all my comments. Did you took them into account?

@rafal-hawrylak
rafal-hawrylak merged commit da31d53 into main Oct 9, 2026
10 checks passed
@rafal-hawrylak
rafal-hawrylak deleted the docs/cli-readme branch October 9, 2026 11:42
ihistand added a commit to SQLAnvil/sqlanvil that referenced this pull request Oct 9, 2026
Adds cli/README.md, a full reference for every command and flag, the
credentials file, and worked examples. It mirrors
sqlanvil.com/docs/reference/cli. The @sqlanvil/cli package now ships it as
its README instead of the root README, as upstream did in
dataform-co/dataform#2364. The unused //cli:readme copy rule is removed
because it generated a file at the same path.

Also fixes CLI issues found while writing it:
- run: register --job-prefix. It was read but never declared, so strict
  mode rejected it ("Unknown arguments: job-prefix").
- run: drop the duplicate credentialsOption.
- --database-suffix: help text was a copy of --assertion-schema's.
- validate: help text said Postgres/Supabase/MySQL only; BigQuery is
  supported via dry run.

Co-Authored-By: Claude Opus 5.5 <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.

2 participants