appwrite-cli

Guides correct usage of the Appwrite CLI for project configuration, deployment, and code generation.

4|Updated Feb 5, 2025
One-click install
npx skills add https://github.com/aniruddha81/Gaali-Finder-v2 --skill appwrite-cli-aniruddha81
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: appwrite-cli
Source: https://github.com/aniruddha81/Gaali-Finder-v2/tree/main/.agents/skills/appwrite-cli
Command: npx skills add https://github.com/aniruddha81/Gaali-Finder-v2 --skill appwrite-cli-aniruddha81

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Developers frequently misuse the Appwrite CLI by mixing one-off API calls with project configuration, mishandling authentication layers, or generating stale type-safe code, leading to broken deployments and lost schema state. ## Core Features & Use Cases - Config vs Client Guidance: Distinguishes when to use appwrite.config.json for real projects versus appwrite client for one-off operations, preventing scattered state. - Type-Safe Code Generation: Explains appwrite generate for full TypeScript TablesDB wrappers and appwrite types for other languages like Kotlin, Swift, and Dart. - Deployment Best Practices: Covers push/pull workflows, --force usage in CI, function variable handling, and regional Cloud endpoints. - Use Case: When setting up CI to deploy Appwrite functions, use this Skill to correctly authenticate with an API key, push with --force, and avoid committing secrets to the repository. ## Quick Start Ask the AI to explain how to initialize an Appwrite project and push table schema changes using the CLI.

Frequently Asked Questions about appwrite-cli

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I use the Appwrite CLI to manage project schema?

Initialize a project with `appwrite init project`, then edit appwrite.config.json and run `appwrite push table --force` to apply changes. Pull first with `appwrite pull table` if the remote schema is the source of truth.

What is the difference between appwrite generate and appwrite types?

`appwrite generate` produces a complete type-safe TypeScript wrapper for TablesDB including query builders, while `appwrite types` generates model interfaces for multiple languages like Kotlin, Swift, and Dart without typed query APIs.

How do I authenticate the Appwrite CLI in CI pipelines?

Use `appwrite client --key "$APPWRITE_API_KEY"` with the key stored in environment variables, never committed to the repository. Combine with `--force` on push commands since CI has no interactive terminal.

Why does appwrite push show empty local values in the change table?

Empty local values mean appwrite.config.json is missing those fields. Run `appwrite pull` for that resource first to sync the config, then push again instead of forcing through the mismatch.

When should I use appwrite client instead of appwrite.config.json?

Use `appwrite client` for one-off operations like inspecting a single user or patching one row. Use appwrite.config.json for real projects with schemas, functions, and deployments that must survive fresh clones.