Appwrite CLI

Installation

# npm

npm install -g appwrite-cli

# macOS (Homebrew native binary)

brew tap appwrite/appwrite

brew install appwrite/appwrite/appwrite

# macOS / Linux (script)

curl -sL https://appwrite.io/cli/install.sh | bash

# Windows (Scoop)

scoop install https://raw.githubusercontent.com/appwrite/sdk-for-cli/master/scoop/appwrite.config.json

Verify installation:

appwrite -v

Login & Initialization

# Login to your account

appwrite login

# Login to a self-hosted instance

appwrite login --endpoint "https://your-instance.com/v1"

# Switch to a different saved account

appwrite login --switch

# Initialize a project (creates appwrite.config.json)

appwrite init project

# Verify by fetching project info

appwrite projects get --project-id "<PROJECT_ID>"

appwrite whoami can show https://cloud.appwrite.io/v1 as the account login endpoint. That is expected for Appwrite Cloud login. Do not rewrite it to a regional endpoint. Only project configuration and project-scoped API calls use the region endpoint, such as https://<REGION>.cloud.appwrite.io/v1.

Configuration

# Switch endpoint/project for scripted use

appwrite client --endpoint "https://<REGION>.cloud.appwrite.io/v1"

appwrite client --project-id "<PROJECT_ID>"

For the full list of CLI commands, see CLI Commands.

For headless / CI/CD usage, see Non-Interactive Mode.

appwrite.config.json

Resources can be configured inline in appwrite.config.json or split into separate JSON array files using includes.

{

    "projectId": "<PROJECT_ID>",

    "projectName": "Production",

    "endpoint": "https://<REGION>.cloud.appwrite.io/v1",

    "includes": {

        "functions": "appwrite/functions.json",

        "sites": "appwrite/sites.json",

        "webhooks": "appwrite/webhooks.json"

    },

    "settings": {

        "services": {

            "account": true,

            "databases": true,

            "functions": true,

            "sites": true,

            "messaging": true

        },

        "protocols": {

            "rest": true,

            "graphql": true,

            "websocket": true

        },

        "auth": {

            "methods": {

                "email-password": true,

                "magic-url": true

            },

            "security": {

                "sessionsLimit": 10,

                "passwordDictionary": true

            }

        }

    },

    "tablesDB": [],

    "tables": [],

    "buckets": [],

    "teams": [],

    "topics": []

}

Each includes value must be a relative .json path inside the project directory and must point to a JSON array. A resource cannot be defined both inline and in includes. When functions or sites are included, their path values are resolved relative to the include file directory.

Example appwrite/functions.json:

[

    {

        "$id": "<FUNCTION_ID>",

        "name": "userAuth",

        "enabled": true,

        "logging": true,

        "runtime": "node-22",

        "buildSpecification": "s-1vcpu-512mb",

        "runtimeSpecification": "s-1vcpu-512mb",

        "deploymentRetention": 7,

        "events": [],

        "schedule": "",

        "timeout": 15,

        "entrypoint": "src/main.js",

        "commands": "npm install",

        "ignore": "node_modules\n.tmp",

        "path": "../functions/userAuth"

    }

]

Pull and push project configuration

# Pull or push everything

appwrite pull all --all

appwrite push all --all

# Pull or push individual resource groups

appwrite pull settings

appwrite push settings

appwrite pull webhooks

appwrite push webhooks

appwrite pull functions

appwrite push functions

Deploying Functions

# Create a new function

appwrite init functions

# Pull existing functions from Console

appwrite pull functions

# Deploy functions

appwrite push functions

Function configuration in appwrite.config.json

{

    "functions": [

        {

            "$id": "<FUNCTION_ID>",

            "name": "userAuth",

            "enabled": true,

            "logging": true,

            "runtime": "node-22",

            "buildSpecification": "s-1vcpu-512mb",

            "runtimeSpecification": "s-1vcpu-512mb",

            "deploymentRetention": 7,

            "scopes": [],

            "events": [],

            "schedule": "",

            "timeout": 15,

            "entrypoint": "src/main.js",

            "commands": "npm install",

            "ignore": "node_modules\n.tmp",

            "path": "functions/userAuth"

        }

    ]

}

Key function config fields:

Function commands

List functions with flag-based queries

Prefer the query flags for common filtering, sorting, and pagination. Use --queries only for raw Appwrite JSON query strings or advanced automation.

appwrite functions list \

    --where 'name=api' \

    --sort-desc '$createdAt' \

    --limit 10 \

    --offset 0 \

    --json

appwrite functions list-deployments \

    --function-id <FUNCTION_ID> \

    --limit 5 \

    --cursor-after <DEPLOYMENT_ID>

Trigger a function with body

appwrite functions create-execution \

    --function-id <FUNCTION_ID> \

    --body '{"key": "value"}'

Local development

appwrite run functions

Deployment activation

# Deploy and activate the deployment

appwrite push functions --function-id <FUNCTION_ID> --activate

# Deploy without switching live traffic

appwrite push functions --function-id <FUNCTION_ID> --activate=false

Function variables

Do not define function variables in appwrite.config.json. Put them in a .env file inside the configured function path. Variables are saved after they are pushed, so use --with-variables only when you want to create, replace, or remove the remote variables from the local .env file.

# functions/userAuth/.env

PUBLIC_FLAG=enabled

SECRET_TOKEN=replace-me

# Sync function variables from .env

appwrite push functions --function-id <FUNCTION_ID> --with-variables

# Push code without changing saved variables

appwrite push functions --function-id <FUNCTION_ID>

# Run locally with variables fetched from function settings

appwrite run functions --with-variables

Deploying Sites

# Create a new site

appwrite init sites

# Pull existing sites from Console

appwrite pull sites

# Deploy sites

appwrite push sites

Site configuration in appwrite.config.json

{

    "sites": [

        {

            "$id": "<SITE_ID>",

            "name": "Documentation template",

            "logging": true,

            "framework": "astro",

            "timeout": 30,

            "installCommand": "npm install",

            "buildCommand": "npm run build",

            "outputDirectory": "./dist",

            "buildSpecification": "s-1vcpu-512mb",

            "runtimeSpecification": "s-1vcpu-512mb",

            "buildRuntime": "node-22",

            "adapter": "ssr",

            "fallbackFile": "",

            "startCommand": "npm run start",

            "deploymentRetention": 7,

            "path": "sites/documentation-template"

        }

    ]

}

Key site config fields:

Site commands

Site variables

Do not define site variables in appwrite.config.json. Put them in a .env file inside the configured site path. Variables are saved after they are pushed, so use --with-variables only when you want to create, replace, or remove the remote variables from the local .env file.

# sites/documentation-template/.env

PUBLIC_SITE_NAME=docs

appwrite push sites --site-id <SITE_ID> --with-variables

# Push code without changing saved variables

appwrite push sites --site-id <SITE_ID>

Managing Tables (Databases)

# Create a new table

appwrite init tables

# Pull existing tables from Console

appwrite pull tables

# Deploy tables

appwrite push tables

Table configuration in appwrite.config.json

{

    "tablesDB": [

        {

            "$id": "<DATABASE_ID>",

            "name": "songs",

            "enabled": true

        }

    ],

    "tables": [

        {

            "$id": "<TABLE_ID>",

            "$permissions": ["create(\"any\")", "read(\"any\")"],

            "databaseId": "<DATABASE_ID>",

            "name": "music",

            "enabled": true,

            "rowSecurity": false,

            "columns": [

                {

                    "key": "title",

                    "type": "varchar",

                    "required": true,

                    "size": 255

                }

            ],

            "indexes": []

        }

    ]

}

Database commands (TablesDB)

Column type commands

Note: The legacy string type is deprecated. Use explicit string column types instead.

All column commands use appwrite tables-db <command> --database-id <ID> --table-id <ID>.

Row operations

# Create a row

appwrite tables-db create-row \

    --database-id "<DATABASE_ID>" --table-id "<TABLE_ID>" \

    --row-id 'unique()' --data '{ "title": "Hello World" }' \

    --permissions 'read("any")' 'write("team:abc")'

# List rows (JSON output)

appwrite tables-db list-rows \

    --database-id "<DATABASE_ID>" --table-id "<TABLE_ID>" --json

# Get a row

appwrite tables-db get-row \

    --database-id "<DATABASE_ID>" --table-id "<TABLE_ID>" --row-id "<ROW_ID>"

List rows and documents with query flags

Use --where, --sort-asc, --sort-desc, --limit, --offset, --cursor-after, and --cursor-before on list commands. Row and document list/get commands also support repeated --select flags.

appwrite tables-db list-rows \

    --database-id "<DATABASE_ID>" \

    --table-id "<TABLE_ID>" \

    --where 'status=active' \

    --where 'score>=10' \

    --sort-asc 'name' \

    --select '$id' \

    --select 'name' \

    --limit 25 \

    --json

appwrite databases list-documents \

    --database-id "<DATABASE_ID>" \

    --collection-id "<COLLECTION_ID>" \

    --where 'email!=null' \

    --cursor-before "<DOCUMENT_ID>"

--where parses strings, numbers, booleans, null, and JSON arrays. Supported operators are =, !=, >, >=, <, and <=.

Managing Buckets (Storage)

# Create a new bucket

appwrite init buckets

# Pull existing buckets from Console

appwrite pull buckets

# Deploy buckets

appwrite push buckets

Storage commands

Managing Teams

# Create a new team

appwrite init teams

# Pull existing teams from Console

appwrite pull teams

# Deploy teams

appwrite push teams

Team commands

Managing Webhooks

# Pull existing webhooks from Console

appwrite pull webhooks

# Deploy configured webhooks

appwrite push webhooks

Webhook configuration in appwrite/webhooks.json

[

    {

        "$id": "<WEBHOOK_ID>",

        "name": "Deploy events",

        "url": "https://example.com/appwrite/webhook",

        "events": ["functions.*.deployments.*.create"],

        "enabled": true,

        "tls": true

    }

]

Webhook commands

Managing Topics (Messaging)

# Create a new topic

appwrite init topics

# Pull existing topics from Console

appwrite pull topics

# Deploy topics

appwrite push topics

Messaging commands

User Management

# Create a user

appwrite users create --user-id "unique()" \

    --email hello@appwrite.io

# List users

appwrite users list

# Get a user

appwrite users get --user-id "<USER_ID>"

# Delete a user

appwrite users delete --user-id "<USER_ID>"

Project Management

Project-level commands use the singular project service for current-project operations that do not need --project-id.

# Project settings and policies

appwrite project update-service --service-id functions --enabled true

appwrite project update-protocol --protocol-id rest --enabled true

appwrite project list-policies

appwrite project get-policy --policy-id "<POLICY_ID>"

# OAuth2 providers

appwrite project list-o-auth-2-providers

appwrite project get-o-auth-2-provider --provider github

appwrite project update-o-auth-2-git-hub --enabled true

# Mock phones and short-lived API keys

appwrite project create-mock-phone --phone "+12025550123" --otp "123456"

appwrite project list-mock-phones

appwrite project create-ephemeral-key

Generate Type-Safe SDK

# Auto-detect language and generate

appwrite generate

# Specify output directory

appwrite generate --output ./src/generated

# Specify language

appwrite generate --language typescript

# Override generated import settings

appwrite generate --appwrite-import-source node-appwrite --import-extension .js

Generated files:

Usage:

import { databases } from "./generated/appwrite";

const customers = databases.use("main").use("customers");

// Create

const customer = await customers.create({

    name: "Walter O' Brian",

    email: "walter@example.com"

});

// List with typed queries

const results = await customers.list({

    queries: (q) => [

        q.equal("name", "Walter O' Brian"),

        q.orderDesc("$createdAt"),

        q.limit(10)

    ]

});

// Update

await customers.update("customer-id-123", {

    email: "walter@scorpion.com"

});

// Delete

await customers.delete("customer-id-123");

// Bulk create

await customers.createMany([

    { name: "Walter O' Brian", email: "walter@example.com" },

    { name: "Paige Dineen", email: "paige@example.com" }

]);

Non-Interactive / CI/CD Mode

For headless automation, see the Non-Interactive Mode docs.

Deploy non-interactively

# Push everything

appwrite push all --all --force

# Push specific resources

appwrite push functions --all --force

appwrite push functions --function-id <FUNCTION_ID> --force

appwrite push sites --all --force

appwrite push tables --all --force

appwrite push teams --all --force

appwrite push buckets --all --force

appwrite push webhooks --all --force

appwrite push topics --all --force

Global Command Options

Maintenance Commands

# Update CLI using the detected install method

appwrite update

# Show manual update instructions

appwrite update --manual

# Install shell completions

appwrite completion install

Examples

# List users with JSON output

appwrite users list --json

# Get verbose error output

appwrite users list --verbose

# View a row in the Console

appwrite tables-db get-row \

    --database-id "<DATABASE_ID>" \

    --table-id "<TABLE_ID>" \

    --row-id "<ROW_ID>" \

    --console --open

# Generate error report

appwrite login --report