skills.rest
SMGolamAlif
SMGolamAlifCOMMUNITY
Explore all skills by this author →
Website𝕏@SMGolamAlifGitHub

appwrite-cli

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

Updated Jul 29, 2026
Search Tags:#deployment#backend#cli#ci#type generation#appwrite#tablesdb
One-click install
npx skills add https://github.com/SMGolamAlif/Orbit --skill appwrite-cli-smgolamalif
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: appwrite-cli
Source: https://github.com/SMGolamAlif/Orbit/tree/main/.agents/skills/appwrite-cli
Command: npx skills add https://github.com/SMGolamAlif/Orbit --skill appwrite-cli-smgolamalif

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? The Appwrite CLI has many commands and flags, and common mistakes—like treating a real project as one-off API calls, forcing pushes against empty local config, or leaking API keys into committed files—cause broken deployments and lost schema state. This Skill encodes the correct workflows so you avoid those traps. ## Core Features & Use Cases - Config vs one-off decisions: Learn when to use appwrite.config.json with init/pull/push versus appwrite client for single API calls, and how auth, endpoints, and environment variables interact. - Type-safe code generation: Generate a fully typed TypeScript TablesDB wrapper with appwrite generate, or model types in eight languages with appwrite types, always derived from the local config. - Safe deployments and queries: Push functions, sites, and tables with correct --force, --with-variables, and --activate flags, and query data with --filter, --sort-desc, and cursor pagination instead of deprecated flags. - Use Case: You are setting up CI to deploy an Appwrite function. The Skill tells you to check in appwrite.config.json without secrets, authenticate with appwrite client --key "$APPWRITE_API_KEY", and run appwrite push function --force. ## Quick Start Ask the AI to help you initialize an Appwrite project, pull its table schema, and generate type-safe TypeScript code using the Appwrite CLI.

Frequently Asked Questions about appwrite-cli

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

FAQPage Schema
How do I deploy an Appwrite function with the CLI?▼

Run appwrite push function --function-id <id> --activate --force from a directory containing appwrite.config.json. The --force flag is required in CI since there is no TTY for confirmation prompts. Omit --with-variables unless you intend to replace remote variables from the local .env file.

When should I use appwrite.config.json vs appwrite client?▼

Use appwrite.config.json for real projects with schema, functions, and deploys—init once, then pull and push. Use appwrite client only for one-off operations like inspecting a single user or row against a remote you will not return to.

How do I generate TypeScript types from an Appwrite table schema?▼

Run appwrite generate for a fully typed TablesDB wrapper covering queries, payloads, and rows, or appwrite types <output> --language ts for model interfaces only. Both read the local appwrite.config.json, so pull the table first if the remote schema is newer.

How do I authenticate the Appwrite CLI in CI?▼

Use appwrite client --key "$APPWRITE_API_KEY" with the key stored in environment variables, never committed to the repo. Check in appwrite.config.json without secrets; environment variables like APPWRITE_PROJECT_ID override the config file.

Why does appwrite push show remote values with empty local columns?▼

An empty local column means the config is missing those fields, not that they should be overwritten. Pull that resource first with appwrite pull settings or pull table, then push—do not force through the mismatch.

Does the Appwrite CLI support regional Cloud endpoints?▼

Yes. Project API calls use regional hosts like https://fra.cloud.appwrite.io/v1, pinned into the config by init project or client --project-id. The account login host stays https://cloud.appwrite.io/v1 and should not be changed.

Related Skills

Explore More Software Engineering Skills→
appwriteappwrite
1

appwrite-cli

Manages Appwrite projects, functions, sites, tables, and storage from the command line.

Official
Intermediate
HollowvynHollowvyn

trpc-type-safety

Share tRPC router types between TypeScript client and server with Zod validation.

Official
Intermediate
aadilmallickaadilmallick

appwrite-cli

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

Community
Intermediate
LuisaGroupLuisaGroup
1.0k

xir_passes

Author and test XIR transformation passes for the LuisaCompute compiler IR.

Official
Advanced