Skip to content
terminal

GitHub Action

Setup Appwrite CLI

v1 Pre-release

Setup Appwrite CLI

terminal

Setup Appwrite CLI

A GitHub Action to setup Appwrite CLI

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Setup Appwrite CLI

uses: appwrite/setup-for-appwrite@v1

Learn more about this action in appwrite/setup-for-appwrite

Choose a version

Appwrite CLI for GitHub Actions

License Version

Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the CLI to integrate your CI with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to https://appwrite.io/docs

Appwrite

Usage

The action will setup Appwrite CLI for all following task. key should be defined as an encrypted secret and not be exposed directly.

- uses: appwrite/setup-for-actions@v1
  with:
    endpoint: 'https://[HOSTNAME_OR_IP]/v1'
    project: '[PROJECT_ID]'
    key: '${{ secrets.APPWRITE_API_KEY }}'

Great! Now you're all set to use the Appwrite CLI. You can access your CLI using the appwrite command:

- name: Some Appwrite CLI action
  run: appwrite users list

You can read more about the CLI here and in our docs.