Skip to content

docs: CLI workflow updates for webhooks, deployment logs, and run command#2892

Open
atharva-appwrite wants to merge 1 commit intomainfrom
cli-workflow-docs-update
Open

docs: CLI workflow updates for webhooks, deployment logs, and run command#2892
atharva-appwrite wants to merge 1 commit intomainfrom
cli-workflow-docs-update

Conversation

@atharva-appwrite
Copy link
Copy Markdown

Summary

  • New webhooks CLI doc page (/docs/tooling/command-line/webhooks): Documents appwrite pull webhooks and appwrite push webhooks commands, config format, supported fields, and webhook CRUD commands
  • Deployment log streaming section in commands reference: Documents realtime WebSocket-based build log streaming during push functions/push sites, the --no-logs flag, and automatic fallback to polling
  • Updated CLI commands reference: Push/pull descriptions now include webhooks; init command mentions personalized next steps; run command describes source validation and startup detection
  • Updated develop-locally docs: Notes source code validation and startup detection improvements for appwrite run functions
  • Changelog entry (2026-04-16): Summarizes webhook management, deployment log streaming, and run command improvements
  • Sidebar navigation: Added Webhooks to the CLI Deployments section

Test plan

  • Verify the new webhooks page renders correctly at /docs/tooling/command-line/webhooks
  • Verify the webhooks link appears in the CLI sidebar navigation under Deployments
  • Verify the changelog entry renders at /changelog
  • Verify the deployment logs section appears on the commands page
  • Verify all internal links resolve correctly (webhook references from commands page, arrow_link in changelog)

🤖 Generated with Claude Code

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
Copy link
Copy Markdown

appwrite bot commented Apr 16, 2026

Appwrite Website

Project ID: 69d7efb00023389e8d27

Sites (1)
Site Status Logs Preview QR
 website
69d7f2670014e24571ca
Failed Failed View Logs Preview URL QR Code

Website (appwrite/website)

Project ID: 684969cb000a2f6c0a02

Sites (1)
Site Status Logs Preview QR
 website
68496a17000f03d62013
Processing Processing View Logs Preview URL QR Code


Tip

Trigger functions via HTTP, SDKs, events, webhooks, or scheduled cron jobs

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Apr 16, 2026

Greptile Summary

This PR adds documentation for three CLI improvements: a new webhooks management page (pull/push webhooks, config schema, CRUD commands), a deployment log streaming section in the commands reference, and updated descriptions for the run command and develop-locally guide.

Confidence Score: 5/5

Safe 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 appwrite projects namespace note; src/routes/docs/tooling/command-line/commands/+page.markdoc — "topics" vs "messaging-topics".

Important Files Changed

Filename Overview
src/routes/docs/tooling/command-line/webhooks/+page.markdoc New webhooks CLI doc page; well-structured and consistent with other resource pages, but the appwrite projects namespace for CRUD commands is non-obvious and deserves a clarifying note, and the file is missing a trailing newline.
src/routes/docs/tooling/command-line/commands/+page.markdoc Updated push/pull/run/init descriptions and added a deployment logs section; minor inconsistency: push description uses "topics" while pull and init use "messaging-topics".
src/routes/docs/tooling/command-line/+layout.svelte Adds Webhooks entry to the CLI sidebar under Deployments; straightforward and consistent with the existing navigation structure.
src/routes/docs/products/functions/develop-locally/+page.markdoc Adds a sentence documenting source code validation and startup detection improvements for appwrite run functions; clear and accurate.
src/routes/changelog/(entries)/2026-04-16.markdoc New changelog entry summarizing webhook management, deployment log streaming, and run improvements; links to the new webhooks doc page.

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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 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.

Suggested change
* 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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 Missing trailing newline

The file is missing a newline at the end (\ No newline at end of file in the diff). Most editors and linters expect files to end with a newline, and it's consistent with other .markdoc pages in the project.

Suggested change
{% /table %}
---
{% /table %}

Comment on lines +107 to +109

```sh
appwrite projects [COMMAND] [OPTIONS]
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 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!

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.

1 participant