{"id":15136566,"url":"https://github.com/appwrite/setup-for-appwrite","last_synced_at":"2025-10-19T15:32:24.151Z","repository":{"id":43014508,"uuid":"338043764","full_name":"appwrite/setup-for-appwrite","owner":"appwrite","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-04T13:50:34.000Z","size":1000,"stargazers_count":24,"open_issues_count":1,"forks_count":4,"subscribers_count":16,"default_branch":"main","last_synced_at":"2025-01-31T18:45:44.755Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/appwrite.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-02-11T13:56:50.000Z","updated_at":"2024-12-23T06:16:59.000Z","dependencies_parsed_at":"2024-06-20T07:35:38.781Z","dependency_job_id":"63dd09e1-9041-42fe-8eb4-8bb404f133b7","html_url":"https://github.com/appwrite/setup-for-appwrite","commit_stats":null,"previous_names":["appwrite/setup-for-appwrite","appwrite/setup-for-actions"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appwrite%2Fsetup-for-appwrite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appwrite%2Fsetup-for-appwrite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appwrite%2Fsetup-for-appwrite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appwrite%2Fsetup-for-appwrite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/appwrite","download_url":"https://codeload.github.com/appwrite/setup-for-appwrite/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237163053,"owners_count":19265204,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest"],"created_at":"2024-09-26T06:23:17.124Z","updated_at":"2025-10-19T15:32:18.782Z","avatar_url":"https://github.com/appwrite.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Appwrite CLI for GitHub Actions\n\n![banner.png](assets/banner.png)\n\n![License](https://img.shields.io/github/license/appwrite/setup-for-appwrite.svg?v=1)\n![Version](https://img.shields.io/badge/api%20version-1.5.6-blue.svg?v=1)\n\nAppwrite is an open-source backend as a service server that abstracts and simplifies 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.\n\nUse the CLI to integrate your CI with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools.\nFor full API documentation and tutorials, go to [https://appwrite.io/docs](https://appwrite.io/docs)\n\n## Introduction\n\nThis action can be used in many ways:\n\n- To add Appwrite CLI to your GitHub actions\n- To log in to your Appwrite instance using **email and password**.\n- To log in to your Appwrite instance using an **API key and project ID**.\n- Optionally: you can pass a list of action to execute using the Appwrite CLI.\n\n### Inputes\n\n#### ``endpoint``\n\nRequired: **NO**\n\nAppwrite Endpoint, e.g. `https://cloud.appwrite.io/v1`\n\n#### ``method``\n\nRequired: **NO**\n\nEnter the login method to your Appwrite instance, available options\n\n- email\n- key\n\nWhen using email, you'll need to pass email and password\n\n```yaml\n - name: Appwrite action\n   uses: appwrite/setup-for-appwrite@v2\n     with:\n       method: email\n       email: ${{ secrets.EMAIL }}\n       password: ${{ secrets.PASSWORD }}\n```\n\nWhen using key you'll need to pass the API key and project ID\n\n```yaml\n - name: Appwrite action\n   uses: appwrite/setup-for-appwrite@v2\n     with:\n       method: key\n       key: ${{ secrets.API_KEY }}\n       project: ${{ vars.PROJECT_ID }}\n       self_signed: true\n```\n\n#### ``email``\n\nRequired: **NO**\n\nUser email\n\n#### ``password``\n\nRequired: **NO**\n\nUser password\n\n#### ``project``\n\nRequired: **NO**\n\nProject ID\n\n#### ``key``\n\nRequired: **NO**\n\nAPI Key\n\n#### ``self_signed``\n\nRequired: **NO**\n\nWhether you are using a self-signed, local certificate\n\n#### ``force``\n\nRequired: **NO**\n\nWhen set to `true`, push or pull actions will have the `--force` flag\n\n#### ``all``\n\nRequired: **NO**\n\nWhen set to `true`, push or pull actions will have the `--all` flag\n\n#### ``actions``\n\nRequired: **NO**\n\nList of appwrite actions to execute, you can use write the command with or without the leading `appwrite`\n\n```yaml\nactions: |-\n  appwrite push functions\n  push collections       \n```\n\n## Usage\n### Basic example \n```yaml\nname: List of users\n\non:\n  workflow_dispatch:\n    \njobs:\n  migrate:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout repository\n        uses: actions/checkout@v4\n      - name: Setup Appwrite\n        uses: appwrite/setup-for-appwrite@v2\n      - name: List users\n        run: appwrite users list\n```\n\n### Full email example\n```yaml\nname: Database Migrations\n\n\non:\n  release:\n    types: [ published ]\n\njobs:\n  migrate:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout repository\n        uses: actions/checkout@v4\n      - name: Setup Appwrite\n        uses: appwrite/setup-for-appwrite@v2\n        with:\n          method: email\n          email: ${{ secrets.EMAIL }}\n          password: ${{ secrets.PASSWORD }}\n          force: true\n          all: true\n          actions: |-\n            push collections\n  \n```\n\nYou can read more about the CLI [here](https://appwrite.io/docs/tooling/command-line/installation) and in our [docs](https://appwrite.io/docs).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappwrite%2Fsetup-for-appwrite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fappwrite%2Fsetup-for-appwrite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappwrite%2Fsetup-for-appwrite/lists"}