Skip to content

Commit 855441b

Browse files
committed
feat: review comments
1 parent 6358abc commit 855441b

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

templates/cli/README.md.twig

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ $ {{ language.params.executableName }} init
4343

4444
The CLI requires an endpoint, project ID, API key and a locale to be able to communicate with the {{ spec.title | caseUcfirst }} backend server. There are two ways to achieve this
4545

46-
### 1. Pass in the project settings along with `appwrite init`
46+
### 1. Pass in the project settings along with `{{ language.params.executableName }} init`
4747

4848
```sh
4949
$ {{ language.params.executableName }} init --endpoint="YOUR ENDPOINT" --project="YOUR PROJECT ID" --key="YOUR API KEY" --locale="YOUR LOCALE"
@@ -58,7 +58,7 @@ Invoking `{{ language.params.executableName }} init` without any params triggers
5858
### Note
5959
By default, requests to domains with self signed SSL certificates (or no certificates) are disabled. If you trust the domain, you can bypass the certificate validation by using
6060
```sh
61-
$ appwrite client setSelfSigned --value=true
61+
$ {{ language.params.executableName }} client setSelfSigned --value=true
6262
```
6363

6464
## Usage
@@ -109,9 +109,9 @@ This library is auto-generated by {{ spec.title | caseUcfirst }} custom [SDK Gen
109109

110110
To build and test the CLI for development, follow these steps
111111

112-
1. Clone the [SDK Generator](https://github.com/appwrite/sdk-generator)
112+
1. Clone the SDK Generator
113113
```sh
114-
$ git clone https://github.com/appwrite/sdk-generator
114+
$ git clone https://github.com/{{ spec.title | lower }}/sdk-generator
115115
```
116116

117117
2. Ensure that docker is running locally and then run
@@ -128,15 +128,15 @@ $ docker run --rm -v $(pwd):/app -w /app php:7.4-cli php example.php
128128
3. Head over to the generated SDK and build the CLI docker image
129129
```sh
130130
$ cd examples/CLI
131-
$ docker build -t appwrite/cli .
131+
$ docker build -t {{ spec.title | lower }}/cli .
132132
```
133133

134134
4. Install the CLI
135135

136136
MacOS and Linux
137137

138-
Open `install.sh` and change [this line](https://github.com/appwrite/sdk-for-cli/blob/master/install.sh#L33) to `APPWRITE_CLI_IMAGE_VERSION=latest` and
139-
comment [these lines](https://github.com/appwrite/sdk-for-cli/blob/master/install.sh#L119-L123).
138+
Open `install.sh` and change [this line](https://github.com/{{ spec.title | lower }}/sdk-for-cli/blob/master/install.sh#L33) to `{{ spec.title | upper }}_CLI_IMAGE_VERSION=latest` and
139+
comment [these lines](https://github.com/{{ spec.title | lower }}/sdk-for-cli/blob/master/install.sh#L119-L123).
140140

141141
You can now install the CLI using
142142
```sh
@@ -146,8 +146,8 @@ $ ./install.sh
146146

147147
Windows
148148

149-
Open `install.ps1` and change [this line](https://github.com/appwrite/sdk-for-cli/blob/master/install.ps1#L28) to `APPWRITE_CLI_IMAGE_VERSION=latest` and
150-
comment [these lines](https://github.com/appwrite/sdk-for-cli/blob/master/install.ps1#L85-L89)
149+
Open `install.ps1` and change [this line](https://github.com/{{ spec.title | lower }}/sdk-for-cli/blob/master/install.ps1#L28) to `{{ spec.title | upper }}_CLI_IMAGE_VERSION=latest` and
150+
comment [these lines](https://github.com/{{ spec.title | lower }}/sdk-for-cli/blob/master/install.ps1#L85-L89)
151151

152152
You can now install the CLI using
153153
```sh

0 commit comments

Comments
 (0)