Repository navigation
docs: refresh README - #16
ChiragAgg5k wants to merge 1 commit into
Conversation
🔵 Tier A · Mergeable after minor fixes
Rewrites the Appwrite CLI skill from a command catalog into workflow guidance covering project config, authentication, regional endpoints, schema changes, code generation, deployments, and query/output patterns. Adds a 0.3.0 changelog entry describing the update.
Fix with agent prompt### Issue 1
skills/appwrite-cli/SKILL.md:55
**Select functions explicitly in the CI example**
This CI example still prompts to choose which configured functions to push; `--force` accepts confirmations but does not select resources, so the command fails in a TTY-less runner. Add `--all` to push every configured function, or pass `--function-id` for one.
### Issue 2
skills/appwrite-cli/SKILL.md:148
**Include Python among supported `types` languages**
The CLI also accepts `--language python`, but this supported-language list omits it, which can lead Python users to think the generator is unavailable to them. Add `Python (`python`)` to the list.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.📂 Walkthrough · 2
Reviewed |
|
Opened by mistake from the existing dev branch; a README-only PR replaces it. |
| appwrite push all --all | ||
| # Good — CI against a checked-in config | ||
| appwrite client --key "$APPWRITE_API_KEY" | ||
| appwrite push function --force |
There was a problem hiding this comment.
Select functions explicitly in the CI example
This CI example still prompts to choose which configured functions to push; --force accepts confirmations but does not select resources, so the command fails in a TTY-less runner. Add --all to push every configured function, or pass --function-id for one.
Prompt To Fix With AI
This is a comment left during a code review.
Path: skills/appwrite-cli/SKILL.md
Line: 55
Comment:
**Select functions explicitly in the CI example**
This CI example still prompts to choose which configured functions to push; `--force` accepts confirmations but does not select resources, so the command fails in a TTY-less runner. Add `--all` to push every configured function, or pass `--function-id` for one.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.🟡 Minor · documentation · Reply if this doesn't apply.
| | `appwrite teams delete-membership --team-id <ID> --membership-id <ID>` | Remove a member | | ||
| | `appwrite teams get-prefs --team-id <ID>` | Get team preferences | | ||
| | `appwrite teams update-prefs --team-id <ID>` | Update team preferences | | ||
| For another supported language, or when the project deliberately uses the regular SDK directly, use `appwrite types <output-directory>`. It supports TypeScript (`ts`), JavaScript (`js`), PHP (`php`), Kotlin (`kotlin`), Swift (`swift`), Java (`java`), Dart (`dart`), and C# (`cs`). Pass these short values to `--language`; names such as `typescript` and `csharp` are not the command's accepted values. Generated files type row data, but they do **not** type-check raw database/table IDs or `Query` calls: |
There was a problem hiding this comment.
Include Python among supported types languages
The CLI also accepts --language python, but this supported-language list omits it, which can lead Python users to think the generator is unavailable to them. Add Python (python) to the list.
Prompt To Fix With AI
This is a comment left during a code review.
Path: skills/appwrite-cli/SKILL.md
Line: 148
Comment:
**Include Python among supported `types` languages**
The CLI also accepts `--language python`, but this supported-language list omits it, which can lead Python users to think the generator is unavailable to them. Add `Python (`python`)` to the list.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.🟡 Minor · documentation · Reply if this doesn't apply.
Refreshes the README with the rewritten getting-started guide and corrected badges, links and install steps from appwrite/sdk-generator#2077 and appwrite/appwrite#14613.
README files only. No code, version or changelog changes, so this does not need a release.