appwrite-cli 4.2.2 → 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (314) hide show
  1. package/.github/workflows/npm-publish.yml +1 -1
  2. package/README.md +6 -9
  3. package/docs/examples/account/{create-email-session.md → create-email-password-session.md} +1 -1
  4. package/docs/examples/account/create-email-token.md +4 -0
  5. package/docs/examples/account/create-magic-u-r-l-token.md +5 -0
  6. package/docs/examples/account/create-mfa-authenticator.md +2 -0
  7. package/docs/examples/account/create-mfa-challenge.md +2 -0
  8. package/docs/examples/account/create-mfa-recovery-codes.md +1 -0
  9. package/docs/examples/account/create-o-auth2token.md +5 -0
  10. package/docs/examples/account/create-phone-token.md +3 -0
  11. package/docs/examples/account/create-push-target.md +4 -0
  12. package/docs/examples/account/create-session.md +3 -0
  13. package/docs/examples/account/create.md +1 -1
  14. package/docs/examples/account/delete-identity.md +1 -1
  15. package/docs/examples/account/delete-mfa-authenticator.md +3 -0
  16. package/docs/examples/account/delete-push-target.md +2 -0
  17. package/docs/examples/account/delete-session.md +1 -1
  18. package/docs/examples/account/delete.md +1 -0
  19. package/docs/examples/account/get-mfa-recovery-codes.md +1 -0
  20. package/docs/examples/account/get-session.md +1 -1
  21. package/docs/examples/account/list-mfa-factors.md +1 -0
  22. package/docs/examples/account/update-m-f-a.md +2 -0
  23. package/docs/examples/account/update-magic-u-r-l-session.md +2 -2
  24. package/docs/examples/account/update-mfa-authenticator.md +3 -0
  25. package/docs/examples/account/update-mfa-challenge.md +3 -0
  26. package/docs/examples/account/update-mfa-recovery-codes.md +1 -0
  27. package/docs/examples/account/update-name.md +1 -1
  28. package/docs/examples/account/update-phone-session.md +2 -2
  29. package/docs/examples/account/update-phone-verification.md +2 -2
  30. package/docs/examples/account/update-push-target.md +3 -0
  31. package/docs/examples/account/update-recovery.md +3 -4
  32. package/docs/examples/account/update-session.md +1 -1
  33. package/docs/examples/account/update-verification.md +2 -2
  34. package/docs/examples/assistant/chat.md +1 -1
  35. package/docs/examples/avatars/get-q-r.md +1 -1
  36. package/docs/examples/databases/create-boolean-attribute.md +2 -2
  37. package/docs/examples/databases/create-collection.md +3 -3
  38. package/docs/examples/databases/create-datetime-attribute.md +2 -2
  39. package/docs/examples/databases/create-document.md +3 -3
  40. package/docs/examples/databases/create-email-attribute.md +2 -2
  41. package/docs/examples/databases/create-enum-attribute.md +2 -2
  42. package/docs/examples/databases/create-float-attribute.md +2 -2
  43. package/docs/examples/databases/create-index.md +2 -2
  44. package/docs/examples/databases/create-integer-attribute.md +2 -2
  45. package/docs/examples/databases/create-ip-attribute.md +2 -2
  46. package/docs/examples/databases/create-relationship-attribute.md +3 -3
  47. package/docs/examples/databases/create-string-attribute.md +2 -2
  48. package/docs/examples/databases/create-url-attribute.md +2 -2
  49. package/docs/examples/databases/create.md +2 -2
  50. package/docs/examples/databases/delete-attribute.md +2 -2
  51. package/docs/examples/databases/delete-collection.md +2 -2
  52. package/docs/examples/databases/delete-document.md +3 -3
  53. package/docs/examples/databases/delete-index.md +2 -2
  54. package/docs/examples/databases/delete.md +1 -1
  55. package/docs/examples/databases/get-attribute.md +2 -2
  56. package/docs/examples/databases/get-collection-usage.md +2 -2
  57. package/docs/examples/databases/get-collection.md +2 -2
  58. package/docs/examples/databases/get-database-usage.md +1 -1
  59. package/docs/examples/databases/get-document.md +3 -3
  60. package/docs/examples/databases/get-index.md +2 -2
  61. package/docs/examples/databases/get.md +1 -1
  62. package/docs/examples/databases/list-attributes.md +2 -2
  63. package/docs/examples/databases/list-collection-logs.md +2 -2
  64. package/docs/examples/databases/list-collections.md +1 -1
  65. package/docs/examples/databases/list-document-logs.md +3 -3
  66. package/docs/examples/databases/list-documents.md +2 -2
  67. package/docs/examples/databases/list-indexes.md +2 -2
  68. package/docs/examples/databases/list-logs.md +1 -1
  69. package/docs/examples/databases/update-boolean-attribute.md +2 -2
  70. package/docs/examples/databases/update-collection.md +3 -3
  71. package/docs/examples/databases/update-datetime-attribute.md +2 -2
  72. package/docs/examples/databases/update-document.md +3 -3
  73. package/docs/examples/databases/update-email-attribute.md +2 -2
  74. package/docs/examples/databases/update-enum-attribute.md +3 -3
  75. package/docs/examples/databases/update-float-attribute.md +2 -2
  76. package/docs/examples/databases/update-integer-attribute.md +2 -2
  77. package/docs/examples/databases/update-ip-attribute.md +2 -2
  78. package/docs/examples/databases/update-relationship-attribute.md +2 -2
  79. package/docs/examples/databases/update-string-attribute.md +3 -3
  80. package/docs/examples/databases/update-url-attribute.md +2 -2
  81. package/docs/examples/databases/update.md +2 -2
  82. package/docs/examples/functions/create-build.md +3 -3
  83. package/docs/examples/functions/create-deployment.md +1 -1
  84. package/docs/examples/functions/create-execution.md +1 -1
  85. package/docs/examples/functions/create-variable.md +3 -3
  86. package/docs/examples/functions/create.md +3 -3
  87. package/docs/examples/functions/delete-deployment.md +2 -2
  88. package/docs/examples/functions/delete-variable.md +2 -2
  89. package/docs/examples/functions/delete.md +1 -1
  90. package/docs/examples/functions/download-deployment.md +2 -2
  91. package/docs/examples/functions/get-deployment.md +2 -2
  92. package/docs/examples/functions/get-execution.md +2 -2
  93. package/docs/examples/functions/get-function-usage.md +1 -1
  94. package/docs/examples/functions/get-variable.md +2 -2
  95. package/docs/examples/functions/get.md +1 -1
  96. package/docs/examples/functions/list-deployments.md +1 -1
  97. package/docs/examples/functions/list-executions.md +1 -1
  98. package/docs/examples/functions/list-variables.md +1 -1
  99. package/docs/examples/functions/update-deployment.md +2 -2
  100. package/docs/examples/functions/update-variable.md +3 -3
  101. package/docs/examples/functions/update.md +2 -2
  102. package/docs/examples/health/get-certificate.md +2 -0
  103. package/docs/examples/health/get-failed-jobs.md +3 -0
  104. package/docs/examples/health/get-queue-usage-dump.md +2 -0
  105. package/docs/examples/health/get-queue-usage.md +2 -0
  106. package/docs/examples/health/get-storage.md +1 -0
  107. package/docs/examples/messaging/create-apns-provider.md +9 -0
  108. package/docs/examples/messaging/create-email.md +13 -0
  109. package/docs/examples/messaging/create-fcm-provider.md +5 -0
  110. package/docs/examples/messaging/create-mailgun-provider.md +11 -0
  111. package/docs/examples/messaging/create-msg91provider.md +7 -0
  112. package/docs/examples/messaging/create-push.md +17 -0
  113. package/docs/examples/messaging/create-sendgrid-provider.md +9 -0
  114. package/docs/examples/messaging/create-sms.md +8 -0
  115. package/docs/examples/messaging/create-smtp-provider.md +15 -0
  116. package/docs/examples/messaging/create-subscriber.md +4 -0
  117. package/docs/examples/messaging/create-telesign-provider.md +7 -0
  118. package/docs/examples/messaging/create-textmagic-provider.md +7 -0
  119. package/docs/examples/messaging/create-topic.md +4 -0
  120. package/docs/examples/messaging/create-twilio-provider.md +7 -0
  121. package/docs/examples/messaging/create-vonage-provider.md +7 -0
  122. package/docs/examples/messaging/delete-provider.md +2 -0
  123. package/docs/examples/messaging/delete-subscriber.md +3 -0
  124. package/docs/examples/messaging/delete-topic.md +2 -0
  125. package/docs/examples/messaging/delete.md +2 -0
  126. package/docs/examples/messaging/get-message.md +2 -0
  127. package/docs/examples/messaging/get-provider.md +2 -0
  128. package/docs/examples/messaging/get-subscriber.md +3 -0
  129. package/docs/examples/messaging/get-topic.md +2 -0
  130. package/docs/examples/messaging/list-message-logs.md +3 -0
  131. package/docs/examples/messaging/list-messages.md +3 -0
  132. package/docs/examples/messaging/list-provider-logs.md +3 -0
  133. package/docs/examples/messaging/list-providers.md +3 -0
  134. package/docs/examples/messaging/list-subscriber-logs.md +3 -0
  135. package/docs/examples/messaging/list-subscribers.md +4 -0
  136. package/docs/examples/messaging/list-targets.md +3 -0
  137. package/docs/examples/messaging/list-topic-logs.md +3 -0
  138. package/docs/examples/messaging/list-topics.md +3 -0
  139. package/docs/examples/messaging/update-apns-provider.md +9 -0
  140. package/docs/examples/messaging/update-email.md +12 -0
  141. package/docs/examples/messaging/update-fcm-provider.md +5 -0
  142. package/docs/examples/messaging/update-mailgun-provider.md +11 -0
  143. package/docs/examples/messaging/update-msg91provider.md +7 -0
  144. package/docs/examples/messaging/update-push.md +17 -0
  145. package/docs/examples/messaging/update-sendgrid-provider.md +9 -0
  146. package/docs/examples/messaging/update-sms.md +8 -0
  147. package/docs/examples/messaging/update-smtp-provider.md +15 -0
  148. package/docs/examples/messaging/update-telesign-provider.md +7 -0
  149. package/docs/examples/messaging/update-textmagic-provider.md +7 -0
  150. package/docs/examples/messaging/update-topic.md +4 -0
  151. package/docs/examples/messaging/update-twilio-provider.md +7 -0
  152. package/docs/examples/messaging/update-vonage-provider.md +7 -0
  153. package/docs/examples/migrations/create-appwrite-migration.md +2 -2
  154. package/docs/examples/migrations/create-firebase-migration.md +1 -1
  155. package/docs/examples/migrations/create-firebase-o-auth-migration.md +1 -1
  156. package/docs/examples/migrations/create-n-host-migration.md +6 -6
  157. package/docs/examples/migrations/create-supabase-migration.md +4 -4
  158. package/docs/examples/migrations/delete.md +1 -1
  159. package/docs/examples/migrations/get-appwrite-report.md +2 -2
  160. package/docs/examples/migrations/get-firebase-report-o-auth.md +1 -1
  161. package/docs/examples/migrations/get-firebase-report.md +1 -1
  162. package/docs/examples/migrations/get-n-host-report.md +6 -6
  163. package/docs/examples/migrations/get-supabase-report.md +4 -4
  164. package/docs/examples/migrations/get.md +1 -1
  165. package/docs/examples/migrations/retry.md +1 -1
  166. package/docs/examples/project/create-variable.md +2 -2
  167. package/docs/examples/project/delete-variable.md +1 -1
  168. package/docs/examples/project/get-usage.md +2 -0
  169. package/docs/examples/project/get-variable.md +1 -1
  170. package/docs/examples/project/update-variable.md +2 -2
  171. package/docs/examples/projects/create-key.md +2 -2
  172. package/docs/examples/projects/create-platform.md +2 -2
  173. package/docs/examples/projects/create-smtp-test.md +11 -0
  174. package/docs/examples/projects/create-webhook.md +4 -3
  175. package/docs/examples/projects/create.md +2 -2
  176. package/docs/examples/projects/delete-email-template.md +1 -1
  177. package/docs/examples/projects/delete-key.md +2 -2
  178. package/docs/examples/projects/delete-platform.md +2 -2
  179. package/docs/examples/projects/delete-sms-template.md +1 -1
  180. package/docs/examples/projects/delete-webhook.md +2 -2
  181. package/docs/examples/projects/delete.md +1 -1
  182. package/docs/examples/projects/get-email-template.md +1 -1
  183. package/docs/examples/projects/get-key.md +2 -2
  184. package/docs/examples/projects/get-platform.md +2 -2
  185. package/docs/examples/projects/get-sms-template.md +1 -1
  186. package/docs/examples/projects/get-webhook.md +2 -2
  187. package/docs/examples/projects/get.md +1 -1
  188. package/docs/examples/projects/list-keys.md +1 -1
  189. package/docs/examples/projects/list-platforms.md +1 -1
  190. package/docs/examples/projects/list-webhooks.md +1 -1
  191. package/docs/examples/projects/update-api-status-all.md +3 -0
  192. package/docs/examples/projects/update-api-status.md +4 -0
  193. package/docs/examples/projects/update-auth-duration.md +1 -1
  194. package/docs/examples/projects/update-auth-limit.md +1 -1
  195. package/docs/examples/projects/update-auth-password-dictionary.md +1 -1
  196. package/docs/examples/projects/update-auth-password-history.md +1 -1
  197. package/docs/examples/projects/update-auth-sessions-limit.md +1 -1
  198. package/docs/examples/projects/update-auth-status.md +1 -1
  199. package/docs/examples/projects/update-email-template.md +3 -3
  200. package/docs/examples/projects/update-key.md +3 -3
  201. package/docs/examples/projects/update-o-auth2.md +1 -1
  202. package/docs/examples/projects/update-personal-data-check.md +1 -1
  203. package/docs/examples/projects/update-platform.md +3 -3
  204. package/docs/examples/projects/update-service-status-all.md +1 -1
  205. package/docs/examples/projects/update-service-status.md +1 -1
  206. package/docs/examples/projects/update-sms-template.md +2 -2
  207. package/docs/examples/projects/update-smtp.md +11 -0
  208. package/docs/examples/projects/update-team.md +2 -2
  209. package/docs/examples/projects/update-webhook-signature.md +2 -2
  210. package/docs/examples/projects/update-webhook.md +5 -4
  211. package/docs/examples/projects/update.md +2 -2
  212. package/docs/examples/proxy/delete-rule.md +1 -1
  213. package/docs/examples/proxy/get-rule.md +1 -1
  214. package/docs/examples/proxy/update-rule-verification.md +1 -1
  215. package/docs/examples/storage/create-bucket.md +2 -2
  216. package/docs/examples/storage/create-file.md +2 -2
  217. package/docs/examples/storage/delete-bucket.md +1 -1
  218. package/docs/examples/storage/delete-file.md +2 -2
  219. package/docs/examples/storage/get-bucket-usage.md +1 -1
  220. package/docs/examples/storage/get-bucket.md +1 -1
  221. package/docs/examples/storage/get-file-download.md +2 -2
  222. package/docs/examples/storage/get-file-preview.md +2 -2
  223. package/docs/examples/storage/get-file-view.md +2 -2
  224. package/docs/examples/storage/get-file.md +2 -2
  225. package/docs/examples/storage/list-files.md +1 -1
  226. package/docs/examples/storage/update-bucket.md +2 -2
  227. package/docs/examples/storage/update-file.md +2 -2
  228. package/docs/examples/teams/create-membership.md +1 -1
  229. package/docs/examples/teams/create.md +2 -2
  230. package/docs/examples/teams/delete-membership.md +2 -2
  231. package/docs/examples/teams/delete.md +1 -1
  232. package/docs/examples/teams/get-membership.md +2 -2
  233. package/docs/examples/teams/get-prefs.md +1 -1
  234. package/docs/examples/teams/get.md +1 -1
  235. package/docs/examples/teams/list-logs.md +1 -1
  236. package/docs/examples/teams/list-memberships.md +1 -1
  237. package/docs/examples/teams/update-membership-status.md +4 -4
  238. package/docs/examples/teams/update-membership.md +2 -2
  239. package/docs/examples/teams/update-name.md +2 -2
  240. package/docs/examples/teams/update-prefs.md +1 -1
  241. package/docs/examples/users/create-argon2user.md +1 -1
  242. package/docs/examples/users/create-bcrypt-user.md +1 -1
  243. package/docs/examples/users/create-m-d5user.md +1 -1
  244. package/docs/examples/users/create-mfa-recovery-codes.md +2 -0
  245. package/docs/examples/users/create-p-h-pass-user.md +1 -1
  246. package/docs/examples/users/create-s-h-a-user.md +1 -1
  247. package/docs/examples/users/create-scrypt-modified-user.md +4 -4
  248. package/docs/examples/users/create-scrypt-user.md +2 -2
  249. package/docs/examples/users/create-session.md +2 -0
  250. package/docs/examples/users/create-target.md +7 -0
  251. package/docs/examples/users/create-token.md +4 -0
  252. package/docs/examples/users/create.md +1 -1
  253. package/docs/examples/users/delete-identity.md +1 -1
  254. package/docs/examples/users/delete-mfa-authenticator.md +3 -0
  255. package/docs/examples/users/delete-session.md +2 -2
  256. package/docs/examples/users/delete-sessions.md +1 -1
  257. package/docs/examples/users/delete-target.md +3 -0
  258. package/docs/examples/users/delete.md +1 -1
  259. package/docs/examples/users/get-mfa-recovery-codes.md +2 -0
  260. package/docs/examples/users/get-prefs.md +1 -1
  261. package/docs/examples/users/get-target.md +3 -0
  262. package/docs/examples/users/get-usage.md +0 -1
  263. package/docs/examples/users/get.md +1 -1
  264. package/docs/examples/users/list-logs.md +1 -1
  265. package/docs/examples/users/list-memberships.md +1 -1
  266. package/docs/examples/users/list-mfa-factors.md +2 -0
  267. package/docs/examples/users/list-sessions.md +1 -1
  268. package/docs/examples/users/list-targets.md +3 -0
  269. package/docs/examples/users/update-email-verification.md +1 -1
  270. package/docs/examples/users/update-email.md +1 -1
  271. package/docs/examples/users/update-labels.md +1 -1
  272. package/docs/examples/users/update-mfa-recovery-codes.md +2 -0
  273. package/docs/examples/users/update-mfa.md +3 -0
  274. package/docs/examples/users/update-name.md +2 -2
  275. package/docs/examples/users/update-password.md +1 -1
  276. package/docs/examples/users/update-phone-verification.md +1 -1
  277. package/docs/examples/users/update-phone.md +1 -1
  278. package/docs/examples/users/update-prefs.md +1 -1
  279. package/docs/examples/users/update-status.md +1 -1
  280. package/docs/examples/users/update-target.md +6 -0
  281. package/docs/examples/vcs/create-repository-detection.md +2 -2
  282. package/docs/examples/vcs/create-repository.md +2 -2
  283. package/docs/examples/vcs/delete-installation.md +1 -1
  284. package/docs/examples/vcs/get-installation.md +1 -1
  285. package/docs/examples/vcs/get-repository.md +2 -2
  286. package/docs/examples/vcs/list-repositories.md +1 -1
  287. package/docs/examples/vcs/list-repository-branches.md +2 -2
  288. package/docs/examples/vcs/update-external-deployments.md +3 -3
  289. package/index.js +2 -0
  290. package/install.ps1 +2 -2
  291. package/install.sh +1 -1
  292. package/lib/client.js +4 -4
  293. package/lib/commands/account.js +906 -226
  294. package/lib/commands/avatars.js +3 -3
  295. package/lib/commands/databases.js +22 -22
  296. package/lib/commands/deploy.js +45 -6
  297. package/lib/commands/functions.js +5 -5
  298. package/lib/commands/health.js +193 -1
  299. package/lib/commands/messaging.js +2815 -0
  300. package/lib/commands/migrations.js +2 -2
  301. package/lib/commands/project.js +15 -5
  302. package/lib/commands/projects.js +210 -72
  303. package/lib/commands/proxy.js +1 -1
  304. package/lib/commands/storage.js +6 -6
  305. package/lib/commands/teams.js +2 -2
  306. package/lib/commands/users.js +545 -14
  307. package/lib/paginate.js +2 -2
  308. package/lib/parser.js +1 -0
  309. package/package.json +1 -1
  310. package/scoop/appwrite.json +3 -3
  311. package/docs/examples/account/create-magic-u-r-l-session.md +0 -4
  312. package/docs/examples/account/create-phone-session.md +0 -3
  313. package/docs/examples/projects/get-usage.md +0 -3
  314. package/docs/examples/projects/update-smtp-configuration.md +0 -11
package/docs/examples/migrations/create-firebase-migration.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite migrations createFirebaseMigration \
2
2
  --resources one two three \
3
- --serviceAccount [SERVICE_ACCOUNT]
3
+ --serviceAccount <SERVICE_ACCOUNT>
package/docs/examples/migrations/create-firebase-o-auth-migration.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite migrations createFirebaseOAuthMigration \
2
2
  --resources one two three \
3
- --projectId [PROJECT_ID]
3
+ --projectId <PROJECT_ID>
package/docs/examples/migrations/create-n-host-migration.md CHANGED
@@ -1,9 +1,9 @@
1
1
  appwrite migrations createNHostMigration \
2
2
  --resources one two three \
3
- --subdomain [SUBDOMAIN] \
4
- --region [REGION] \
5
- --adminSecret [ADMIN_SECRET] \
6
- --database [DATABASE] \
7
- --username [USERNAME] \
8
- --password [PASSWORD] \
3
+ --subdomain <SUBDOMAIN> \
4
+ --region <REGION> \
5
+ --adminSecret <ADMIN_SECRET> \
6
+ --database <DATABASE> \
7
+ --username <USERNAME> \
8
+ --password <PASSWORD> \
9
9
 
package/docs/examples/migrations/create-supabase-migration.md CHANGED
@@ -1,8 +1,8 @@
1
1
  appwrite migrations createSupabaseMigration \
2
2
  --resources one two three \
3
3
  --endpoint https://example.com \
4
- --apiKey [API_KEY] \
5
- --databaseHost [DATABASE_HOST] \
6
- --username [USERNAME] \
7
- --password [PASSWORD] \
4
+ --apiKey <API_KEY> \
5
+ --databaseHost <DATABASE_HOST> \
6
+ --username <USERNAME> \
7
+ --password <PASSWORD> \
8
8
 
package/docs/examples/migrations/delete.md CHANGED
@@ -1,2 +1,2 @@
1
1
  appwrite migrations delete \
2
- --migrationId [MIGRATION_ID]
2
+ --migrationId <MIGRATION_ID>
package/docs/examples/migrations/get-appwrite-report.md CHANGED
@@ -1,5 +1,5 @@
1
1
  appwrite migrations getAppwriteReport \
2
2
  --resources one two three \
3
3
  --endpoint https://example.com \
4
- --projectID [PROJECT_ID] \
5
- --key [KEY]
4
+ --projectID <PROJECT_ID> \
5
+ --key <KEY>
package/docs/examples/migrations/get-firebase-report-o-auth.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite migrations getFirebaseReportOAuth \
2
2
  --resources one two three \
3
- --projectId [PROJECT_ID]
3
+ --projectId <PROJECT_ID>
package/docs/examples/migrations/get-firebase-report.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite migrations getFirebaseReport \
2
2
  --resources one two three \
3
- --serviceAccount [SERVICE_ACCOUNT]
3
+ --serviceAccount <SERVICE_ACCOUNT>
package/docs/examples/migrations/get-n-host-report.md CHANGED
@@ -1,9 +1,9 @@
1
1
  appwrite migrations getNHostReport \
2
2
  --resources one two three \
3
- --subdomain [SUBDOMAIN] \
4
- --region [REGION] \
5
- --adminSecret [ADMIN_SECRET] \
6
- --database [DATABASE] \
7
- --username [USERNAME] \
8
- --password [PASSWORD] \
3
+ --subdomain <SUBDOMAIN> \
4
+ --region <REGION> \
5
+ --adminSecret <ADMIN_SECRET> \
6
+ --database <DATABASE> \
7
+ --username <USERNAME> \
8
+ --password <PASSWORD> \
9
9
 
package/docs/examples/migrations/get-supabase-report.md CHANGED
@@ -1,8 +1,8 @@
1
1
  appwrite migrations getSupabaseReport \
2
2
  --resources one two three \
3
3
  --endpoint https://example.com \
4
- --apiKey [API_KEY] \
5
- --databaseHost [DATABASE_HOST] \
6
- --username [USERNAME] \
7
- --password [PASSWORD] \
4
+ --apiKey <API_KEY> \
5
+ --databaseHost <DATABASE_HOST> \
6
+ --username <USERNAME> \
7
+ --password <PASSWORD> \
8
8
 
package/docs/examples/migrations/get.md CHANGED
@@ -1,2 +1,2 @@
1
1
  appwrite migrations get \
2
- --migrationId [MIGRATION_ID]
2
+ --migrationId <MIGRATION_ID>
package/docs/examples/migrations/retry.md CHANGED
@@ -1,2 +1,2 @@
1
1
  appwrite migrations retry \
2
- --migrationId [MIGRATION_ID]
2
+ --migrationId <MIGRATION_ID>
package/docs/examples/project/create-variable.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite project createVariable \
2
- --key [KEY] \
3
- --value [VALUE]
2
+ --key <KEY> \
3
+ --value <VALUE>
package/docs/examples/project/delete-variable.md CHANGED
@@ -1,2 +1,2 @@
1
1
  appwrite project deleteVariable \
2
- --variableId [VARIABLE_ID]
2
+ --variableId <VARIABLE_ID>
package/docs/examples/project/get-usage.md CHANGED
@@ -1,2 +1,4 @@
1
1
  appwrite project getUsage \
2
+ --startDate '' \
3
+ --endDate '' \
2
4
 
package/docs/examples/project/get-variable.md CHANGED
@@ -1,2 +1,2 @@
1
1
  appwrite project getVariable \
2
- --variableId [VARIABLE_ID]
2
+ --variableId <VARIABLE_ID>
package/docs/examples/project/update-variable.md CHANGED
@@ -1,4 +1,4 @@
1
1
  appwrite project updateVariable \
2
- --variableId [VARIABLE_ID] \
3
- --key [KEY] \
2
+ --variableId <VARIABLE_ID> \
3
+ --key <KEY> \
4
4
 
package/docs/examples/projects/create-key.md CHANGED
@@ -1,5 +1,5 @@
1
1
  appwrite projects createKey \
2
- --projectId [PROJECT_ID] \
3
- --name [NAME] \
2
+ --projectId <PROJECT_ID> \
3
+ --name <NAME> \
4
4
  --scopes one two three \
5
5
 
package/docs/examples/projects/create-platform.md CHANGED
@@ -1,7 +1,7 @@
1
1
  appwrite projects createPlatform \
2
- --projectId [PROJECT_ID] \
2
+ --projectId <PROJECT_ID> \
3
3
  --type web \
4
- --name [NAME] \
4
+ --name <NAME> \
5
5
 
6
6
 
7
7
 
package/docs/examples/projects/create-smtp-test.md ADDED
@@ -0,0 +1,11 @@
1
+ appwrite projects createSmtpTest \
2
+ --projectId <PROJECT_ID> \
3
+ --emails one two three \
4
+ --senderName <SENDER_NAME> \
5
+ --senderEmail email@example.com \
6
+ --host '' \
7
+
8
+
9
+
10
+
11
+
package/docs/examples/projects/create-webhook.md CHANGED
@@ -1,8 +1,9 @@
1
1
  appwrite projects createWebhook \
2
- --projectId [PROJECT_ID] \
3
- --name [NAME] \
2
+ --projectId <PROJECT_ID> \
3
+ --name <NAME> \
4
4
  --events one two three \
5
- --url https://example.com \
5
+ --url '' \
6
6
  --security false \
7
7
 
8
8
 
9
+
package/docs/examples/projects/create.md CHANGED
@@ -1,7 +1,7 @@
1
1
  appwrite projects create \
2
2
  --projectId '' \
3
- --name [NAME] \
4
- --teamId [TEAM_ID] \
3
+ --name <NAME> \
4
+ --teamId <TEAM_ID> \
5
5
 
6
6
 
7
7
 
package/docs/examples/projects/delete-email-template.md CHANGED
@@ -1,4 +1,4 @@
1
1
  appwrite projects deleteEmailTemplate \
2
- --projectId [PROJECT_ID] \
2
+ --projectId <PROJECT_ID> \
3
3
  --type verification \
4
4
  --locale af
package/docs/examples/projects/delete-key.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite projects deleteKey \
2
- --projectId [PROJECT_ID] \
3
- --keyId [KEY_ID]
2
+ --projectId <PROJECT_ID> \
3
+ --keyId <KEY_ID>
package/docs/examples/projects/delete-platform.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite projects deletePlatform \
2
- --projectId [PROJECT_ID] \
3
- --platformId [PLATFORM_ID]
2
+ --projectId <PROJECT_ID> \
3
+ --platformId <PLATFORM_ID>
package/docs/examples/projects/delete-sms-template.md CHANGED
@@ -1,4 +1,4 @@
1
1
  appwrite projects deleteSmsTemplate \
2
- --projectId [PROJECT_ID] \
2
+ --projectId <PROJECT_ID> \
3
3
  --type verification \
4
4
  --locale af
package/docs/examples/projects/delete-webhook.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite projects deleteWebhook \
2
- --projectId [PROJECT_ID] \
3
- --webhookId [WEBHOOK_ID]
2
+ --projectId <PROJECT_ID> \
3
+ --webhookId <WEBHOOK_ID>
package/docs/examples/projects/delete.md CHANGED
@@ -1,2 +1,2 @@
1
1
  appwrite projects delete \
2
- --projectId [PROJECT_ID]
2
+ --projectId <PROJECT_ID>
package/docs/examples/projects/get-email-template.md CHANGED
@@ -1,4 +1,4 @@
1
1
  appwrite projects getEmailTemplate \
2
- --projectId [PROJECT_ID] \
2
+ --projectId <PROJECT_ID> \
3
3
  --type verification \
4
4
  --locale af
package/docs/examples/projects/get-key.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite projects getKey \
2
- --projectId [PROJECT_ID] \
3
- --keyId [KEY_ID]
2
+ --projectId <PROJECT_ID> \
3
+ --keyId <KEY_ID>
package/docs/examples/projects/get-platform.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite projects getPlatform \
2
- --projectId [PROJECT_ID] \
3
- --platformId [PLATFORM_ID]
2
+ --projectId <PROJECT_ID> \
3
+ --platformId <PLATFORM_ID>
package/docs/examples/projects/get-sms-template.md CHANGED
@@ -1,4 +1,4 @@
1
1
  appwrite projects getSmsTemplate \
2
- --projectId [PROJECT_ID] \
2
+ --projectId <PROJECT_ID> \
3
3
  --type verification \
4
4
  --locale af
package/docs/examples/projects/get-webhook.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite projects getWebhook \
2
- --projectId [PROJECT_ID] \
3
- --webhookId [WEBHOOK_ID]
2
+ --projectId <PROJECT_ID> \
3
+ --webhookId <WEBHOOK_ID>
package/docs/examples/projects/get.md CHANGED
@@ -1,2 +1,2 @@
1
1
  appwrite projects get \
2
- --projectId [PROJECT_ID]
2
+ --projectId <PROJECT_ID>
package/docs/examples/projects/list-keys.md CHANGED
@@ -1,2 +1,2 @@
1
1
  appwrite projects listKeys \
2
- --projectId [PROJECT_ID]
2
+ --projectId <PROJECT_ID>
package/docs/examples/projects/list-platforms.md CHANGED
@@ -1,2 +1,2 @@
1
1
  appwrite projects listPlatforms \
2
- --projectId [PROJECT_ID]
2
+ --projectId <PROJECT_ID>
package/docs/examples/projects/list-webhooks.md CHANGED
@@ -1,2 +1,2 @@
1
1
  appwrite projects listWebhooks \
2
- --projectId [PROJECT_ID]
2
+ --projectId <PROJECT_ID>
package/docs/examples/projects/update-api-status-all.md ADDED
@@ -0,0 +1,3 @@
1
+ appwrite projects updateApiStatusAll \
2
+ --projectId <PROJECT_ID> \
3
+ --status false
package/docs/examples/projects/update-api-status.md ADDED
@@ -0,0 +1,4 @@
1
+ appwrite projects updateApiStatus \
2
+ --projectId <PROJECT_ID> \
3
+ --api rest \
4
+ --status false
package/docs/examples/projects/update-auth-duration.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite projects updateAuthDuration \
2
- --projectId [PROJECT_ID] \
2
+ --projectId <PROJECT_ID> \
3
3
  --duration 0
package/docs/examples/projects/update-auth-limit.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite projects updateAuthLimit \
2
- --projectId [PROJECT_ID] \
2
+ --projectId <PROJECT_ID> \
3
3
  --limit 0
package/docs/examples/projects/update-auth-password-dictionary.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite projects updateAuthPasswordDictionary \
2
- --projectId [PROJECT_ID] \
2
+ --projectId <PROJECT_ID> \
3
3
  --enabled false
package/docs/examples/projects/update-auth-password-history.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite projects updateAuthPasswordHistory \
2
- --projectId [PROJECT_ID] \
2
+ --projectId <PROJECT_ID> \
3
3
  --limit 0
package/docs/examples/projects/update-auth-sessions-limit.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite projects updateAuthSessionsLimit \
2
- --projectId [PROJECT_ID] \
2
+ --projectId <PROJECT_ID> \
3
3
  --limit 1
package/docs/examples/projects/update-auth-status.md CHANGED
@@ -1,4 +1,4 @@
1
1
  appwrite projects updateAuthStatus \
2
- --projectId [PROJECT_ID] \
2
+ --projectId <PROJECT_ID> \
3
3
  --method email-password \
4
4
  --status false
package/docs/examples/projects/update-email-template.md CHANGED
@@ -1,9 +1,9 @@
1
1
  appwrite projects updateEmailTemplate \
2
- --projectId [PROJECT_ID] \
2
+ --projectId <PROJECT_ID> \
3
3
  --type verification \
4
4
  --locale af \
5
- --subject [SUBJECT] \
6
- --message [MESSAGE] \
5
+ --subject <SUBJECT> \
6
+ --message <MESSAGE> \
7
7
 
8
8
 
9
9
 
package/docs/examples/projects/update-key.md CHANGED
@@ -1,6 +1,6 @@
1
1
  appwrite projects updateKey \
2
- --projectId [PROJECT_ID] \
3
- --keyId [KEY_ID] \
4
- --name [NAME] \
2
+ --projectId <PROJECT_ID> \
3
+ --keyId <KEY_ID> \
4
+ --name <NAME> \
5
5
  --scopes one two three \
6
6
 
package/docs/examples/projects/update-o-auth2.md CHANGED
@@ -1,5 +1,5 @@
1
1
  appwrite projects updateOAuth2 \
2
- --projectId [PROJECT_ID] \
2
+ --projectId <PROJECT_ID> \
3
3
  --provider amazon \
4
4
 
5
5
 
package/docs/examples/projects/update-personal-data-check.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite projects updatePersonalDataCheck \
2
- --projectId [PROJECT_ID] \
2
+ --projectId <PROJECT_ID> \
3
3
  --enabled false
package/docs/examples/projects/update-platform.md CHANGED
@@ -1,7 +1,7 @@
1
1
  appwrite projects updatePlatform \
2
- --projectId [PROJECT_ID] \
3
- --platformId [PLATFORM_ID] \
4
- --name [NAME] \
2
+ --projectId <PROJECT_ID> \
3
+ --platformId <PLATFORM_ID> \
4
+ --name <NAME> \
5
5
 
6
6
 
7
7
 
package/docs/examples/projects/update-service-status-all.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite projects updateServiceStatusAll \
2
- --projectId [PROJECT_ID] \
2
+ --projectId <PROJECT_ID> \
3
3
  --status false
package/docs/examples/projects/update-service-status.md CHANGED
@@ -1,4 +1,4 @@
1
1
  appwrite projects updateServiceStatus \
2
- --projectId [PROJECT_ID] \
2
+ --projectId <PROJECT_ID> \
3
3
  --service account \
4
4
  --status false
package/docs/examples/projects/update-sms-template.md CHANGED
@@ -1,5 +1,5 @@
1
1
  appwrite projects updateSmsTemplate \
2
- --projectId [PROJECT_ID] \
2
+ --projectId <PROJECT_ID> \
3
3
  --type verification \
4
4
  --locale af \
5
- --message [MESSAGE]
5
+ --message <MESSAGE>
package/docs/examples/projects/update-smtp.md ADDED
@@ -0,0 +1,11 @@
1
+ appwrite projects updateSmtp \
2
+ --projectId <PROJECT_ID> \
3
+ --enabled false \
4
+
5
+
6
+
7
+
8
+
9
+
10
+
11
+
package/docs/examples/projects/update-team.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite projects updateTeam \
2
- --projectId [PROJECT_ID] \
3
- --teamId [TEAM_ID]
2
+ --projectId <PROJECT_ID> \
3
+ --teamId <TEAM_ID>
package/docs/examples/projects/update-webhook-signature.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite projects updateWebhookSignature \
2
- --projectId [PROJECT_ID] \
3
- --webhookId [WEBHOOK_ID]
2
+ --projectId <PROJECT_ID> \
3
+ --webhookId <WEBHOOK_ID>
package/docs/examples/projects/update-webhook.md CHANGED
@@ -1,9 +1,10 @@
1
1
  appwrite projects updateWebhook \
2
- --projectId [PROJECT_ID] \
3
- --webhookId [WEBHOOK_ID] \
4
- --name [NAME] \
2
+ --projectId <PROJECT_ID> \
3
+ --webhookId <WEBHOOK_ID> \
4
+ --name <NAME> \
5
5
  --events one two three \
6
- --url https://example.com \
6
+ --url '' \
7
7
  --security false \
8
8
 
9
9
 
10
+
package/docs/examples/projects/update.md CHANGED
@@ -1,6 +1,6 @@
1
1
  appwrite projects update \
2
- --projectId [PROJECT_ID] \
3
- --name [NAME] \
2
+ --projectId <PROJECT_ID> \
3
+ --name <NAME> \
4
4
 
5
5
 
6
6
 
package/docs/examples/proxy/delete-rule.md CHANGED
@@ -1,2 +1,2 @@
1
1
  appwrite proxy deleteRule \
2
- --ruleId [RULE_ID]
2
+ --ruleId <RULE_ID>
package/docs/examples/proxy/get-rule.md CHANGED
@@ -1,2 +1,2 @@
1
1
  appwrite proxy getRule \
2
- --ruleId [RULE_ID]
2
+ --ruleId <RULE_ID>
package/docs/examples/proxy/update-rule-verification.md CHANGED
@@ -1,2 +1,2 @@
1
1
  appwrite proxy updateRuleVerification \
2
- --ruleId [RULE_ID]
2
+ --ruleId <RULE_ID>
package/docs/examples/storage/create-bucket.md CHANGED
@@ -1,6 +1,6 @@
1
1
  appwrite storage createBucket \
2
- --bucketId [BUCKET_ID] \
3
- --name [NAME] \
2
+ --bucketId <BUCKET_ID> \
3
+ --name <NAME> \
4
4
 
5
5
 
6
6
 
package/docs/examples/storage/create-file.md CHANGED
@@ -1,5 +1,5 @@
1
1
  appwrite storage createFile \
2
- --bucketId [BUCKET_ID] \
3
- --fileId [FILE_ID] \
2
+ --bucketId <BUCKET_ID> \
3
+ --fileId <FILE_ID> \
4
4
  --file 'path/to/file.png' \
5
5
 
package/docs/examples/storage/delete-bucket.md CHANGED
@@ -1,2 +1,2 @@
1
1
  appwrite storage deleteBucket \
2
- --bucketId [BUCKET_ID]
2
+ --bucketId <BUCKET_ID>
package/docs/examples/storage/delete-file.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite storage deleteFile \
2
- --bucketId [BUCKET_ID] \
3
- --fileId [FILE_ID]
2
+ --bucketId <BUCKET_ID> \
3
+ --fileId <FILE_ID>
package/docs/examples/storage/get-bucket-usage.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite storage getBucketUsage \
2
- --bucketId [BUCKET_ID] \
2
+ --bucketId <BUCKET_ID> \
3
3
 
package/docs/examples/storage/get-bucket.md CHANGED
@@ -1,2 +1,2 @@
1
1
  appwrite storage getBucket \
2
- --bucketId [BUCKET_ID]
2
+ --bucketId <BUCKET_ID>
package/docs/examples/storage/get-file-download.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite storage getFileDownload \
2
- --bucketId [BUCKET_ID] \
3
- --fileId [FILE_ID]
2
+ --bucketId <BUCKET_ID> \
3
+ --fileId <FILE_ID>
package/docs/examples/storage/get-file-preview.md CHANGED
@@ -1,6 +1,6 @@
1
1
  appwrite storage getFilePreview \
2
- --bucketId [BUCKET_ID] \
3
- --fileId [FILE_ID] \
2
+ --bucketId <BUCKET_ID> \
3
+ --fileId <FILE_ID> \
4
4
 
5
5
 
6
6
 
package/docs/examples/storage/get-file-view.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite storage getFileView \
2
- --bucketId [BUCKET_ID] \
3
- --fileId [FILE_ID]
2
+ --bucketId <BUCKET_ID> \
3
+ --fileId <FILE_ID>
package/docs/examples/storage/get-file.md CHANGED
@@ -1,3 +1,3 @@
1
1
  appwrite storage getFile \
2
- --bucketId [BUCKET_ID] \
3
- --fileId [FILE_ID]
2
+ --bucketId <BUCKET_ID> \
3
+ --fileId <FILE_ID>
package/docs/examples/storage/list-files.md CHANGED
@@ -1,4 +1,4 @@
1
1
  appwrite storage listFiles \
2
- --bucketId [BUCKET_ID] \
2
+ --bucketId <BUCKET_ID> \
3
3
 
4
4
 
package/docs/examples/storage/update-bucket.md CHANGED
@@ -1,6 +1,6 @@
1
1
  appwrite storage updateBucket \
2
- --bucketId [BUCKET_ID] \
3
- --name [NAME] \
2
+ --bucketId <BUCKET_ID> \
3
+ --name <NAME> \
4
4
 
5
5
 
6
6
 
package/docs/examples/storage/update-file.md CHANGED
@@ -1,5 +1,5 @@
1
1
  appwrite storage updateFile \
2
- --bucketId [BUCKET_ID] \
3
- --fileId [FILE_ID] \
2
+ --bucketId <BUCKET_ID> \
3
+ --fileId <FILE_ID> \
4
4
 
5
5
 
package/docs/examples/teams/create-membership.md CHANGED
@@ -1,5 +1,5 @@
1
1
  appwrite teams createMembership \
2
- --teamId [TEAM_ID] \
2
+ --teamId <TEAM_ID> \
3
3
  --roles one two three \
4
4
 
5
5
 
package/docs/examples/teams/create.md CHANGED
@@ -1,4 +1,4 @@
1
1
  appwrite teams create \
2
- --teamId [TEAM_ID] \
3
- --name [NAME] \
2
+ --teamId <TEAM_ID> \
3
+ --name <NAME> \
4
4