Skip to content

docs(cli): document 19.1.0 list query flags#2922

Merged
ChiragAgg5k merged 4 commits intomainfrom
chirag/cli-19.1.0-query-flags
Apr 28, 2026
Merged

docs(cli): document 19.1.0 list query flags#2922
ChiragAgg5k merged 4 commits intomainfrom
chirag/cli-19.1.0-query-flags

Conversation

@ChiragAgg5k
Copy link
Copy Markdown
Member

Summary

  • Document the new flag-based filtering, sorting, and pagination options introduced in Appwrite CLI 19.1.0 on the CLI commands reference.
  • Add a new "Filter, sort, and paginate" section covering --where, --sort-asc, --sort-desc, --limit, --offset, --cursor-after, --cursor-before, and --select, with a worked example and a clear note that --queries is still supported for advanced cases.
  • Update the existing "List users" example to demonstrate the new flags.
  • Add a changelog entry at 2026-04-28.markdoc announcing the change.

The new flags replace the previous workflow where users had to escape Appwrite query JSON inside --queries, which is awkward in a shell. They are additive and fully backwards compatible — when both are passed, raw --queries values are sent first and flag-generated queries are appended after.

Test plan

  • Visit /docs/tooling/command-line/commands and confirm the new "Filter, sort, and paginate" section renders, the table is correctly formatted, and the in-page anchor #filter-sort-paginate works.
  • Confirm the inline link from the updated "List users" example jumps to the new section.
  • Visit the changelog and confirm the new 2026-04-28 entry renders, with both arrow links resolving to the CLI commands reference and the CLI installation "Update your CLI" anchor.
  • Verify the page passes the existing markdoc lint / build pipeline in CI.

Document the new --where, --sort-asc, --sort-desc, --limit, --offset,
--cursor-after, --cursor-before, and --select flags introduced in
Appwrite CLI 19.1.0 on the commands reference page, and add a
changelog entry highlighting the feature. The legacy --queries flag is
still supported and is called out as the option for advanced or
automation cases.
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 28, 2026

Greptile Summary

This PR documents the new flag-based filtering, sorting, and pagination options (--where, --sort-asc, --sort-desc, --limit, --offset, --cursor-after, --cursor-before, --select) introduced in Appwrite CLI 19.1.0, adding a new reference section to the CLI commands page and a matching changelog entry. All previously raised concerns (shell variable expansion via double-quoted $createdAt, shell redirection via unquoted >, and stale databases list-documents command name) have been addressed in the current state of the PR.

Confidence Score: 5/5

Safe to merge — documentation-only change with no runtime impact and all prior review issues resolved.

Both files are pure Markdoc documentation. Previously flagged shell-safety issues (single-quote vs double-quote for $createdAt and > expressions) have been corrected, stale command names have been removed, and the changelog no longer contains conflicting command prefixes. No logic, security, or correctness issues remain.

No files require special attention.

Important Files Changed

Filename Overview
src/routes/changelog/(entries)/2026-04-28.markdoc New changelog entry for CLI 19.1.0 flag documentation; clean prose with no code blocks, single-quoted examples removed, arrow links point to correct anchors.
src/routes/docs/tooling/command-line/commands/+page.markdoc New "Filter, sort, and paginate" section with flag table, worked examples using correct single-quoted shell strings, and updated "List users" example; all previously flagged issues (shell expansion, redirection, stale command names) addressed.

Reviews (4): Last reviewed commit: "update changelog" | Re-trigger Greptile

Comment thread src/routes/docs/tooling/command-line/commands/+page.markdoc Outdated
Comment thread src/routes/changelog/(entries)/2026-04-28.markdoc Outdated
Comment thread src/routes/docs/tooling/command-line/commands/+page.markdoc Outdated
Comment thread src/routes/docs/tooling/command-line/commands/+page.markdoc
- Quote $createdAt with single quotes so the shell does not expand it to
  an empty string in the example invocations.
- Quote --where expressions with single quotes so > and < are not
  interpreted as shell redirection, and call this out in the flag
  description.
- Drop the stale databases list-documents reference from the --select
  description; the rest of the page uses the rows/tables naming.
- Use tables-db (the namespace exposed by the CLI) in the changelog
  example and in-prose command list, replacing the inaccurate
  databases list-rows / databases list-tables references.
Comment thread src/routes/changelog/(entries)/2026-04-28.markdoc Outdated
ChiragAgg5k and others added 2 commits April 28, 2026 08:46
Greptile flagged inconsistency between the new commands reference
content (which used `databases list-rows` / `databases list-tables`)
and the changelog (which uses `tables-db list-rows`). The actual CLI
exposes these under the `tables-db` namespace, so the new commands
section now matches both the changelog and the real CLI command names.
@ChiragAgg5k ChiragAgg5k merged commit 4acb223 into main Apr 28, 2026
6 checks passed
@ChiragAgg5k ChiragAgg5k deleted the chirag/cli-19.1.0-query-flags branch April 28, 2026 07:25
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