From 22d8169bb1dcc8fce57baa72bcc5cc6f55052ed7 Mon Sep 17 00:00:00 2001 From: choir27 Date: Wed, 21 Aug 2024 13:14:00 -0400 Subject: [PATCH 01/18] docs: add section to talk about running tests in non-interactive mode --- .../command-line/installation/+page.markdoc | 4 +-- .../non-interactive/+page.markdoc | 31 ++++++++++++++++++- 2 files changed, 32 insertions(+), 3 deletions(-) diff --git a/src/routes/docs/tooling/command-line/installation/+page.markdoc b/src/routes/docs/tooling/command-line/installation/+page.markdoc index 59ddfdd2c9..1cc3645f93 100644 --- a/src/routes/docs/tooling/command-line/installation/+page.markdoc +++ b/src/routes/docs/tooling/command-line/installation/+page.markdoc @@ -146,10 +146,10 @@ This will create your `appwrite.json` file, where you will configure your variou } ``` -You can run your first CLI command after logging in. Try fetching information about your Appwrite project. +You can run your first CLI command after logging in. Try fetching your users from your project. ```sh -appwrite projects get --project-id "" +appwrite users list ``` {% info title="Self-signed certificates" %} diff --git a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc index d8467e8cef..297f889179 100644 --- a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc +++ b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc @@ -16,6 +16,10 @@ When you set the global configuration parameters using the `appwrite client` com In this mode, the CLI can only interact with one project at a time. +## Placeholder Title {% #placholder-title %} + +To run tests or project-per-branch previews, you will need Console SDK capabilities. To accomplish this, log in using the `appwrite login` and pass in your email, password, and OTP settings as parameters. + # API Keys {% #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](/docs/advanced/platform/api-keys). @@ -67,4 +71,29 @@ Use providers like Github actions to create continuous integrations and continuo ## Github -You can use [Github actions](https://github.com/appwrite/setup-for-actions/tree/feat-cli-g2?tab=readme-ov-file#introduction) to automate your Appwrite CLI commands, allowing you to use them even in non-interactive mode. \ No newline at end of file +You can use [Github actions](https://github.com/appwrite/setup-for-actions/tree/feat-cli-g2?tab=readme-ov-file#introduction) to automate your Appwrite CLI commands, allowing you to use them even in non-interactive mode. + +```yaml +name: Database Migrations + +on: + release: + types: [ published ] + +jobs: + migrate: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + - name: Setup Appwrite + uses: appwrite/setup-for-appwrite@v2 + with: + method: email + email: ${{ secrets.EMAIL }} + password: ${{ secrets.PASSWORD }} + force: true + all: true + actions: |- + push collections +``` \ No newline at end of file From c1a548ae8b8ce1d9892841d66fa1301ebc09602b Mon Sep 17 00:00:00 2001 From: choir27 Date: Wed, 21 Aug 2024 13:40:52 -0400 Subject: [PATCH 02/18] docs: remove placeholder title heading and add cli example for login using email, password, and otp as parameters --- .../docs/tooling/command-line/non-interactive/+page.markdoc | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc index 297f889179..54f15e0e09 100644 --- a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc +++ b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc @@ -16,10 +16,12 @@ When you set the global configuration parameters using the `appwrite client` com In this mode, the CLI can only interact with one project at a time. -## Placeholder Title {% #placholder-title %} - To run tests or project-per-branch previews, you will need Console SDK capabilities. To accomplish this, log in using the `appwrite login` and pass in your email, password, and OTP settings as parameters. +```sh +appwrite login --email "" --password "" --mfa totp +``` + # API Keys {% #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](/docs/advanced/platform/api-keys). From 7a5f58a572bec62c4dcb15dd1ea71bc141e616b1 Mon Sep 17 00:00:00 2001 From: choir27 Date: Wed, 21 Aug 2024 13:48:57 -0400 Subject: [PATCH 03/18] docs: tentavely remove github actions example. Add note for api keys with cli commands functionality. --- .../non-interactive/+page.markdoc | 32 ++++--------------- 1 file changed, 6 insertions(+), 26 deletions(-) diff --git a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc index 54f15e0e09..c97ac18d18 100644 --- a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc +++ b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc @@ -25,6 +25,11 @@ appwrite login --email "" --password "" --mfa totp # API Keys {% #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](/docs/advanced/platform/api-keys). +{% info title="Using API keys with CLI" %} +Some CLI commands won't work with an API key, like the `projects` commands +{% /info %} + + # Deployment {% #deployment %} Appwrite's `push` commands can also be executed in a non-interactive mode. This applies to the following resources: functions, collections, buckets, teams, and messaging topics. @@ -73,29 +78,4 @@ Use providers like Github actions to create continuous integrations and continuo ## Github -You can use [Github actions](https://github.com/appwrite/setup-for-actions/tree/feat-cli-g2?tab=readme-ov-file#introduction) to automate your Appwrite CLI commands, allowing you to use them even in non-interactive mode. - -```yaml -name: Database Migrations - -on: - release: - types: [ published ] - -jobs: - migrate: - runs-on: ubuntu-latest - steps: - - name: Checkout repository - uses: actions/checkout@v4 - - name: Setup Appwrite - uses: appwrite/setup-for-appwrite@v2 - with: - method: email - email: ${{ secrets.EMAIL }} - password: ${{ secrets.PASSWORD }} - force: true - all: true - actions: |- - push collections -``` \ No newline at end of file +You can use [Github actions](https://github.com/appwrite/setup-for-actions/tree/feat-cli-g2?tab=readme-ov-file#introduction) to automate your Appwrite CLI commands, allowing you to use them even in non-interactive mode. \ No newline at end of file From f18334c8ce60d3b2efdbc6def9f7b042cb225b5d Mon Sep 17 00:00:00 2001 From: choir27 Date: Wed, 21 Aug 2024 14:02:34 -0400 Subject: [PATCH 04/18] remove extra space --- .../docs/tooling/command-line/non-interactive/+page.markdoc | 1 - 1 file changed, 1 deletion(-) diff --git a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc index c97ac18d18..6affd68c7d 100644 --- a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc +++ b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc @@ -29,7 +29,6 @@ In non-interactive mode, the CLI uses an API key to authenticate. Your API key m Some CLI commands won't work with an API key, like the `projects` commands {% /info %} - # Deployment {% #deployment %} Appwrite's `push` commands can also be executed in a non-interactive mode. This applies to the following resources: functions, collections, buckets, teams, and messaging topics. From dc3fe80bf00c6768348ec35c21297402f7b75e56 Mon Sep 17 00:00:00 2001 From: choir27 Date: Wed, 21 Aug 2024 14:05:05 -0400 Subject: [PATCH 05/18] add missing punctuation --- .../docs/tooling/command-line/non-interactive/+page.markdoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc index 6affd68c7d..1c09a1e2da 100644 --- a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc +++ b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc @@ -26,7 +26,7 @@ appwrite login --email "" --password "" --mfa totp 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](/docs/advanced/platform/api-keys). {% info title="Using API keys with CLI" %} -Some CLI commands won't work with an API key, like the `projects` commands +Some CLI commands won't work with an API key, like the `projects` commands. {% /info %} # Deployment {% #deployment %} From dd6720a3630610b8ff8df25bb217d7b5fb035989 Mon Sep 17 00:00:00 2001 From: choir27 Date: Wed, 21 Aug 2024 14:06:19 -0400 Subject: [PATCH 06/18] add Appwrite for more clarity. --- src/routes/docs/tooling/command-line/installation/+page.markdoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/routes/docs/tooling/command-line/installation/+page.markdoc b/src/routes/docs/tooling/command-line/installation/+page.markdoc index 1cc3645f93..37e81a6333 100644 --- a/src/routes/docs/tooling/command-line/installation/+page.markdoc +++ b/src/routes/docs/tooling/command-line/installation/+page.markdoc @@ -146,7 +146,7 @@ This will create your `appwrite.json` file, where you will configure your variou } ``` -You can run your first CLI command after logging in. Try fetching your users from your project. +You can run your first CLI command after logging in. Try fetching your users from your Appwrite project. ```sh appwrite users list From 6bdbcac159d4d8a1ed3339f6761900512227b236 Mon Sep 17 00:00:00 2001 From: choir27 Date: Wed, 21 Aug 2024 14:06:44 -0400 Subject: [PATCH 07/18] update wording for better flow --- src/routes/docs/tooling/command-line/installation/+page.markdoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/routes/docs/tooling/command-line/installation/+page.markdoc b/src/routes/docs/tooling/command-line/installation/+page.markdoc index 37e81a6333..704ccd99b8 100644 --- a/src/routes/docs/tooling/command-line/installation/+page.markdoc +++ b/src/routes/docs/tooling/command-line/installation/+page.markdoc @@ -146,7 +146,7 @@ This will create your `appwrite.json` file, where you will configure your variou } ``` -You can run your first CLI command after logging in. Try fetching your users from your Appwrite project. +You can run your first CLI command after logging in. Try fetching the users from your Appwrite project. ```sh appwrite users list From b403b1256e54a55dc1f628b79430b29b7701cb6f Mon Sep 17 00:00:00 2001 From: choir27 Date: Fri, 23 Aug 2024 14:30:28 -0400 Subject: [PATCH 08/18] add transition sentence from paragraph to API keys section --- .../command-line/non-interactive/+page.markdoc | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc index 1c09a1e2da..9c552c49ca 100644 --- a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc +++ b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc @@ -8,7 +8,7 @@ The Appwrite CLI can be used in a non-interactive and headless manner, without s ```sh appwrite client \ --endpoint https://cloud.appwrite.io/v1 \ - --project-id [YOUR_PROJECT_ID] \ + --project-id [PROJECT_ID] \ --key YOUR_API_KEY ``` @@ -16,19 +16,24 @@ When you set the global configuration parameters using the `appwrite client` com In this mode, the CLI can only interact with one project at a time. -To run tests or project-per-branch previews, you will need Console SDK capabilities. To accomplish this, log in using the `appwrite login` and pass in your email, password, and OTP settings as parameters. +Use `appwrite login` with your email, password, and OTP to log in so you can run tests or set up project-per-branch previews, or you log in using an API key. ```sh appwrite login --email "" --password "" --mfa totp ``` # API Keys {% #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](/docs/advanced/platform/api-keys). {% info title="Using API keys with CLI" %} Some CLI commands won't work with an API key, like the `projects` commands. {% /info %} +In non-interactive mode, the CLI also 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](/docs/advanced/platform/api-keys). + +```sh +appwrite client --projectId "" --key "" +``` + # Deployment {% #deployment %} Appwrite's `push` commands can also be executed in a non-interactive mode. This applies to the following resources: functions, collections, buckets, teams, and messaging topics. From c3a072938a946cf6b1e52138bea1922af3064a88 Mon Sep 17 00:00:00 2001 From: Richard <66279068+choir27@users.noreply.github.com> Date: Tue, 27 Aug 2024 11:32:25 -0400 Subject: [PATCH 09/18] Update src/routes/docs/tooling/command-line/installation/+page.markdoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Matej Bačo --- src/routes/docs/tooling/command-line/installation/+page.markdoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/routes/docs/tooling/command-line/installation/+page.markdoc b/src/routes/docs/tooling/command-line/installation/+page.markdoc index 704ccd99b8..881fd89055 100644 --- a/src/routes/docs/tooling/command-line/installation/+page.markdoc +++ b/src/routes/docs/tooling/command-line/installation/+page.markdoc @@ -149,7 +149,7 @@ This will create your `appwrite.json` file, where you will configure your variou You can run your first CLI command after logging in. Try fetching the users from your Appwrite project. ```sh -appwrite users list +appwrite users list --json ``` {% info title="Self-signed certificates" %} From cf14cbf310c3f3eb707695692e8681a98d6c518a Mon Sep 17 00:00:00 2001 From: Richard <66279068+choir27@users.noreply.github.com> Date: Tue, 27 Aug 2024 11:32:33 -0400 Subject: [PATCH 10/18] Update src/routes/docs/tooling/command-line/non-interactive/+page.markdoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Matej Bačo --- .../docs/tooling/command-line/non-interactive/+page.markdoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc index 9c552c49ca..7b08865e96 100644 --- a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc +++ b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc @@ -31,7 +31,7 @@ Some CLI commands won't work with an API key, like the `projects` commands. In non-interactive mode, the CLI also 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](/docs/advanced/platform/api-keys). ```sh -appwrite client --projectId "" --key "" +appwrite client --project-id "" --key "" ``` # Deployment {% #deployment %} From 259127305b7b9431577119ca25604a31a2463d7c Mon Sep 17 00:00:00 2001 From: choir27 Date: Tue, 27 Aug 2024 12:18:56 -0400 Subject: [PATCH 11/18] add authentication section with intro section for sub-sections. Add sub-section email and password and Api keys. Remove mentions of OTP. --- .../command-line/non-interactive/+page.markdoc | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc index 7b08865e96..ff9b71ea02 100644 --- a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc +++ b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc @@ -16,13 +16,19 @@ When you set the global configuration parameters using the `appwrite client` com In this mode, the CLI can only interact with one project at a time. -Use `appwrite login` with your email, password, and OTP to log in so you can run tests or set up project-per-branch previews, or you log in using an API key. +# Authentication {% #authentication %} + +In non-interactive mode, you can authenticate your users using two methods: email and password or API keys. While using an API key does not require an email and password to authenticate users, the API key needs to be generated and does not work for project API calls. + +## Email and password {% #email-and-password %} + +Use `appwrite login` with your email, and password to log in so you can run tests or set up project-per-branch previews, or you log in using an API key. ```sh -appwrite login --email "" --password "" --mfa totp +appwrite login --email "" --password "" ``` -# API Keys {% #api-keys %} +## API Keys {% #api-keys %} {% info title="Using API keys with CLI" %} Some CLI commands won't work with an API key, like the `projects` commands. @@ -31,7 +37,7 @@ Some CLI commands won't work with an API key, like the `projects` commands. In non-interactive mode, the CLI also 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](/docs/advanced/platform/api-keys). ```sh -appwrite client --project-id "" --key "" +appwrite client --project-id "" --key "" ``` # Deployment {% #deployment %} From 7bfdb03ed9eb43c3f831a060887a25523b12794f Mon Sep 17 00:00:00 2001 From: choir27 Date: Wed, 28 Aug 2024 09:27:37 -0400 Subject: [PATCH 12/18] remove whole introduction and reword for better structure/concise nature --- .../command-line/non-interactive/+page.markdoc | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc index ff9b71ea02..13fcd5eb6e 100644 --- a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc +++ b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc @@ -3,18 +3,8 @@ layout: article title: Non-interactive description: Deploy changes to Appwrite projects to migrate databases and collections schema, functions, teams, buckets, and more. --- -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`: -```sh -appwrite client \ - --endpoint https://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.json` thereby switching the CLI to non-interactive mode. - -In this mode, the CLI can only interact with one project at a time. +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. # Authentication {% #authentication %} From 9b6987294c7702b0b6a4759140981343f483425f Mon Sep 17 00:00:00 2001 From: choir27 Date: Thu, 29 Aug 2024 14:08:44 -0400 Subject: [PATCH 13/18] update API keys to singular for accuracy. Change link to arrow link. --- .../command-line/non-interactive/+page.markdoc | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc index 13fcd5eb6e..72b5eeaa8e 100644 --- a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc +++ b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc @@ -4,32 +4,36 @@ title: Non-interactive description: Deploy changes to Appwrite projects to migrate databases and collections schema, functions, teams, buckets, and more. --- -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. +The [Appwrite CLI](/docs/tooling/command-line/installation) 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. # Authentication {% #authentication %} -In non-interactive mode, you can authenticate your users using two methods: email and password or API keys. While using an API key does not require an email and password to authenticate users, the API key needs to be generated and does not work for project API calls. +In non-interactive mode, you can authenticate your users using two methods: email and password. While using an [API key](/docs/advanced/platform/api-keys) does not require an email and password to authenticate users, you need to configure the API key [scopes](/docs/advanced/platform/api-keys#scopes) of the application and does not work for project API calls that update project settings. ## Email and password {% #email-and-password %} -Use `appwrite login` with your email, and password to log in so you can run tests or set up project-per-branch previews, or you log in using an API key. +Use `appwrite login` with your email, and password to log in so you can run tests or set up project-per-branch previews. ```sh appwrite login --email "" --password "" ``` -## API Keys {% #api-keys %} +## API Key {% #api-key %} -{% info title="Using API keys with CLI" %} +{% info title="Using API key with CLI" %} Some CLI commands won't work with an API key, like the `projects` commands. {% /info %} -In non-interactive mode, the CLI also 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](/docs/advanced/platform/api-keys). +In non-interactive mode, the CLI also uses an API key to authenticate. Your API key must have sufficient permissions to execute the commands you plan to use. ```sh appwrite client --project-id "" --key "" ``` +{% arrow_link href="/docs/advanced/platform/api-keys" %} +Learn more about API Keys +{% /arrow_link %} + # Deployment {% #deployment %} Appwrite's `push` commands can also be executed in a non-interactive mode. This applies to the following resources: functions, collections, buckets, teams, and messaging topics. From c10089ca43975bfc593117cb68b9d0af16b32980 Mon Sep 17 00:00:00 2001 From: choir27 Date: Fri, 30 Aug 2024 09:59:31 -0400 Subject: [PATCH 14/18] remove your users for accuracy. undo delete of API key method text content. --- .../docs/tooling/command-line/non-interactive/+page.markdoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc index 72b5eeaa8e..14bf7a9eaa 100644 --- a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc +++ b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc @@ -8,11 +8,11 @@ The [Appwrite CLI](/docs/tooling/command-line/installation) can be used in a non # Authentication {% #authentication %} -In non-interactive mode, you can authenticate your users using two methods: email and password. While using an [API key](/docs/advanced/platform/api-keys) does not require an email and password to authenticate users, you need to configure the API key [scopes](/docs/advanced/platform/api-keys#scopes) of the application and does not work for project API calls that update project settings. +In non-interactive mode, you can authenticate using two methods: email and password or API keys. While using an [API key](/docs/advanced/platform/api-keys) does not require an email and password to authenticate, the API key needs to have its [scopes](/docs/advanced/platform/api-keys#scopes) configured and the API key does not work for project API calls that update project settings. ## Email and password {% #email-and-password %} -Use `appwrite login` with your email, and password to log in so you can run tests or set up project-per-branch previews. +Use `appwrite login` with your email and password to log in. ```sh appwrite login --email "" --password "" From 0e6a144699c41bc3279771e7ba2e7f76bbb8cdde Mon Sep 17 00:00:00 2001 From: Richard <66279068+choir27@users.noreply.github.com> Date: Tue, 3 Sep 2024 09:14:02 -0400 Subject: [PATCH 15/18] Update src/routes/docs/tooling/command-line/non-interactive/+page.markdoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Matej Bačo --- .../docs/tooling/command-line/non-interactive/+page.markdoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc index 14bf7a9eaa..b39205cfb5 100644 --- a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc +++ b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc @@ -4,7 +4,7 @@ title: Non-interactive description: Deploy changes to Appwrite projects to migrate databases and collections schema, functions, teams, buckets, and more. --- -The [Appwrite CLI](/docs/tooling/command-line/installation) 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. +The [Appwrite CLI](/docs/tooling/command-line/installation) can be used in a non-interactive and headless manner. This is especially useful when you want to automate tasks on a continuous integration server. # Authentication {% #authentication %} From 1507a0ff768abbd73c15acfde1efe6e000e890fd Mon Sep 17 00:00:00 2001 From: choir27 Date: Tue, 3 Sep 2024 09:30:23 -0400 Subject: [PATCH 16/18] remove headless for cli accuracy. Update sentence strcture for better wording/flow. Update sentence to list specific operations API key does not work for. --- src/routes/docs/products/functions/executions/+page.markdoc | 4 ++++ .../docs/tooling/command-line/non-interactive/+page.markdoc | 6 +++++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/src/routes/docs/products/functions/executions/+page.markdoc b/src/routes/docs/products/functions/executions/+page.markdoc index 154918e602..1e1c854b70 100644 --- a/src/routes/docs/products/functions/executions/+page.markdoc +++ b/src/routes/docs/products/functions/executions/+page.markdoc @@ -8,6 +8,10 @@ Each time an Appwrite Function runs, an **execution** is created. Each execution has a unique ID. If [you enable execution logs](/docs/products/functions/functions#execution-logs) in your function, you can find function executions logged in the **Executions** tab. +# Synchronous executions {% #synchronous-executions %} + +# Asynchronous executions {% #asynchronous-executions %} + # Execution table {% #execution-table %} In your function's **Executions** tab, you will see a table of your recent executions. diff --git a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc index b39205cfb5..09b73dfd06 100644 --- a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc +++ b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc @@ -4,11 +4,15 @@ title: Non-interactive description: Deploy changes to Appwrite projects to migrate databases and collections schema, functions, teams, buckets, and more. --- +<<<<<<< Updated upstream The [Appwrite CLI](/docs/tooling/command-line/installation) can be used in a non-interactive and headless manner. This is especially useful when you want to automate tasks on a continuous integration server. +======= +The [Appwrite CLI](/docs/tooling/command-line/installation) can be used in a non-interactive manner, without saving configuration or sessions. This is especially useful when you want to automate tasks on a continuous integration server. +>>>>>>> Stashed changes # Authentication {% #authentication %} -In non-interactive mode, you can authenticate using two methods: email and password or API keys. While using an [API key](/docs/advanced/platform/api-keys) does not require an email and password to authenticate, the API key needs to have its [scopes](/docs/advanced/platform/api-keys#scopes) configured and the API key does not work for project API calls that update project settings. +In non-interactive mode, you can authenticate using two methods: email and password or API keys. While using an [API key](/docs/advanced/platform/api-keys) does not require an email and password to authenticate, the API key needs to have its [scopes](/docs/advanced/platform/api-keys#scopes) configured. The API key does not work for administrative operations like changing organization billing, deleting projects, or creating a new project. ## Email and password {% #email-and-password %} From 309ee2f3c9c4682045adbe58e30d4f703ffcbb30 Mon Sep 17 00:00:00 2001 From: choir27 Date: Tue, 3 Sep 2024 09:44:00 -0400 Subject: [PATCH 17/18] Merge: merge with suggested changes --- .../docs/tooling/command-line/non-interactive/+page.markdoc | 4 ---- 1 file changed, 4 deletions(-) diff --git a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc index 09b73dfd06..ae6822bac9 100644 --- a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc +++ b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc @@ -4,11 +4,7 @@ title: Non-interactive description: Deploy changes to Appwrite projects to migrate databases and collections schema, functions, teams, buckets, and more. --- -<<<<<<< Updated upstream The [Appwrite CLI](/docs/tooling/command-line/installation) can be used in a non-interactive and headless manner. This is especially useful when you want to automate tasks on a continuous integration server. -======= -The [Appwrite CLI](/docs/tooling/command-line/installation) can be used in a non-interactive manner, without saving configuration or sessions. This is especially useful when you want to automate tasks on a continuous integration server. ->>>>>>> Stashed changes # Authentication {% #authentication %} From 472e4c62373f458f2d1fe480ebd92cda4134a0a4 Mon Sep 17 00:00:00 2001 From: choir27 Date: Tue, 3 Sep 2024 11:19:03 -0400 Subject: [PATCH 18/18] remove headless for cli accuracy since cli is implicitly always headless --- .../docs/tooling/command-line/non-interactive/+page.markdoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc index ae6822bac9..36205d76ee 100644 --- a/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc +++ b/src/routes/docs/tooling/command-line/non-interactive/+page.markdoc @@ -4,7 +4,7 @@ title: Non-interactive description: Deploy changes to Appwrite projects to migrate databases and collections schema, functions, teams, buckets, and more. --- -The [Appwrite CLI](/docs/tooling/command-line/installation) can be used in a non-interactive and headless manner. This is especially useful when you want to automate tasks on a continuous integration server. +The [Appwrite CLI](/docs/tooling/command-line/installation) can be used in a non-interactive manner. This is especially useful when you want to automate tasks on a continuous integration server. # Authentication {% #authentication %}