docs: CLI workflow updates for webhooks, deployment logs, and run command#2892
docs: CLI workflow updates for webhooks, deployment logs, and run command#2892atharva-appwrite wants to merge 1 commit intomainfrom
Conversation
Add documentation for new CLI workflow features: - New webhooks doc page covering pull/push webhook commands and config format - Deployment log streaming section in commands reference (WebSocket-based live logs) - Updated push/pull command descriptions to include webhooks - Updated run command docs with source validation and startup detection - Changelog entry summarizing all CLI workflow updates - Added webhooks to CLI sidebar navigation Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Appwrite WebsiteProject ID: Website (appwrite/website)Project ID: Tip Trigger functions via HTTP, SDKs, events, webhooks, or scheduled cron jobs |
Greptile SummaryThis PR adds documentation for three CLI improvements: a new webhooks management page ( Confidence Score: 5/5Safe to merge — all findings are minor style/consistency issues with no functional impact. All three comments are P2 (terminology consistency, missing newline, clarifying note). No broken links, logic errors, or structural problems were found. src/routes/docs/tooling/command-line/webhooks/+page.markdoc — trailing newline and Important Files Changed
Reviews (1): Last reviewed commit: "docs: add CLI webhook management, deploy..." | Re-trigger Greptile |
| --- | ||
| * `push` | ||
| * The push command provides a convenient wrapper for pushing your functions, tables, buckets, teams, and topics. | ||
| * The push command provides a convenient wrapper for pushing your functions, tables, buckets, teams, topics, and [webhooks](/docs/tooling/command-line/webhooks). When pushing functions or sites, the CLI streams realtime deployment logs so you can monitor your build progress. |
There was a problem hiding this comment.
Inconsistent terminology: "topics" vs "messaging-topics"
The push description uses "topics" while the pull description on line 77 and the init description on line 74 both use "messaging-topics". This creates a subtle inconsistency for users scanning the table.
| * The push command provides a convenient wrapper for pushing your functions, tables, buckets, teams, topics, and [webhooks](/docs/tooling/command-line/webhooks). When pushing functions or sites, the CLI streams realtime deployment logs so you can monitor your build progress. | |
| * The push command provides a convenient wrapper for pushing your functions, tables, buckets, teams, messaging-topics, and [webhooks](/docs/tooling/command-line/webhooks). When pushing functions or sites, the CLI streams realtime deployment logs so you can monitor your build progress. |
| * `delete-webhook [options]` | ||
| * Delete a webhook by its unique ID. | ||
| --- | ||
| {% /table %} No newline at end of file |
There was a problem hiding this comment.
|
|
||
| ```sh | ||
| appwrite projects [COMMAND] [OPTIONS] |
There was a problem hiding this comment.
Command namespace differs from other CLI resource pages
Every other CLI resource page uses its own top-level namespace (e.g., appwrite storage [COMMAND], appwrite teams [COMMAND], appwrite messaging [COMMAND]). Using appwrite projects [COMMAND] here is correct per Appwrite's API structure (webhooks live under the Projects API), but it's non-obvious to developers who may expect appwrite webhooks [COMMAND] by analogy. A short clarifying note would prevent confusion — e.g., "Webhook operations are part of the Projects API, so they are invoked through the appwrite projects namespace."
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!


Summary
/docs/tooling/command-line/webhooks): Documentsappwrite pull webhooksandappwrite push webhookscommands, config format, supported fields, and webhook CRUD commandspush functions/push sites, the--no-logsflag, and automatic fallback to pollingappwrite run functionsTest plan
/docs/tooling/command-line/webhooks/changelog🤖 Generated with Claude Code