Docs
Skip to content

CLI

Non-interactive_

Deploy changes to Appwrite projects to migrate databases and tables schema, functions, teams, buckets, and more.

2 min read

Raw

The Appwrite CLI can be used in a non-interactive and headless manner, without saving configuration or sessions. This is especially useful when you want to automate tasks on a continuous integration server. You can enable the non-interactive mode for the Appwrite CLI by setting the project ID, endpoint, and API Key:

Bash
appwrite client \
    --endpoint https://<REGION>.cloud.appwrite.io/v1 \
    --project-id <PROJECT_ID> \
    --key YOUR_API_KEY

When you set the global configuration parameters using the appwrite client command, they take precedence over the local configuration parameters in your appwrite.config.json thereby switching the CLI to non-interactive mode.

In this mode, the CLI can only interact with one project at a time.

API Keys

In non-interactive mode, the CLI uses an API key to authenticate. Your API key must have sufficient permissions to execute the commands you plan to use. Learn more about API Keys.

Deployment

Appwrite's push commands can also be executed in a non-interactive mode. This applies to the following resources: functions, tables, buckets, teams, and messaging topics.

You can push a resource non-interactively by using the --force option to skip all warnings and specify which resources you want to deploy.

To push all available resources:

Bash
appwrite push all --all --force

To push a single function by ID:

Bash
appwrite push functions --function-id [FUNCTION ID] --force

Push all functions:

Bash
appwrite push functions --all --force

You can push databases, tables, teams, and buckets non-interactively in a similar way by using the --all and --force option.

Push all databases and tables:

Bash
appwrite push tables --all --force

Push all teams:

Bash
appwrite push teams --all --force

Push all buckets:

Bash
appwrite push buckets --all --force

CI/CD integrations

Use providers like Github actions to create continuous integrations and continuous delivery or deployment (CI/CD).

Github

You can use Github actions to automate your Appwrite CLI commands, allowing you to use them even in non-interactive mode.

Was this page helpful?

Share what worked or what we should fix. Once approved, our agents automatically apply suggested updates to the docs.