Merge pull request #887 from appwrite/feat-add-cli-docs

Added CLI code examples
This commit is contained in:
Eldad A. Fux
2021-02-09 16:06:44 +02:00
committed by GitHub
141 changed files with 157 additions and 13 deletions
@@ -0,0 +1 @@
appwrite avatars getBrowser --code="aa" --width="0" --height="0" --quality="0"
@@ -0,0 +1 @@
appwrite avatars getCreditCard --code="amex" --width="0" --height="0" --quality="0"
@@ -0,0 +1 @@
appwrite avatars getFavicon --url="https://example.com"
@@ -0,0 +1 @@
appwrite avatars getFlag --code="af" --width="0" --height="0" --quality="0"
@@ -0,0 +1 @@
appwrite avatars getImage --url="https://example.com" --width="0" --height="0"
@@ -0,0 +1 @@
appwrite avatars getInitials --name="[NAME]" --width="0" --height="0" --color="" --background=""
@@ -0,0 +1 @@
appwrite avatars getQR --text="[TEXT]" --size="0" --margin="0" --download=""
@@ -0,0 +1 @@
appwrite database createCollection --name="[NAME]" "--read[]=" "--write[]=" "--rules[]="
@@ -0,0 +1 @@
appwrite database createDocument --collectionId="[COLLECTION_ID]" --data="{}" "--read[]=" "--write[]=" --parentDocument="[PARENT_DOCUMENT]" --parentProperty="" --parentPropertyType="assign"
@@ -0,0 +1 @@
appwrite database deleteCollection --collectionId="[COLLECTION_ID]"
@@ -0,0 +1 @@
appwrite database deleteDocument --collectionId="[COLLECTION_ID]" --documentId="[DOCUMENT_ID]"
@@ -0,0 +1 @@
appwrite database getCollection --collectionId="[COLLECTION_ID]"
@@ -0,0 +1 @@
appwrite database getDocument --collectionId="[COLLECTION_ID]" --documentId="[DOCUMENT_ID]"
@@ -0,0 +1 @@
appwrite database listCollections --search="[SEARCH]" --limit="0" --offset="0" --orderType="ASC"
@@ -0,0 +1 @@
appwrite database listDocuments --collectionId="[COLLECTION_ID]" "--filters[]=" --offset="0" --limit="0" --orderField="[ORDER_FIELD]" --orderType="DESC" --orderCast="int" --search="[SEARCH]"
@@ -0,0 +1 @@
appwrite database updateCollection --collectionId="[COLLECTION_ID]" --name="[NAME]" "--read[]=" "--write[]=" "--rules[]="
@@ -0,0 +1 @@
appwrite database updateDocument --collectionId="[COLLECTION_ID]" --documentId="[DOCUMENT_ID]" --data="{}" "--read[]=" "--write[]="
@@ -0,0 +1 @@
appwrite health getAntiVirus
@@ -0,0 +1 @@
appwrite health getCache
@@ -0,0 +1 @@
appwrite health getDB
@@ -0,0 +1 @@
appwrite health getQueueCertificates
@@ -0,0 +1 @@
appwrite health getQueueFunctions
@@ -0,0 +1 @@
appwrite health getQueueLogs
@@ -0,0 +1 @@
appwrite health getQueueTasks
@@ -0,0 +1 @@
appwrite health getQueueUsage
@@ -0,0 +1 @@
appwrite health getQueueWebhooks
@@ -0,0 +1 @@
appwrite health getStorageLocal
@@ -0,0 +1 @@
appwrite health getTime
@@ -0,0 +1 @@
appwrite health get
@@ -0,0 +1 @@
appwrite locale getContinents
@@ -0,0 +1 @@
appwrite locale getCountriesEU
@@ -0,0 +1 @@
appwrite locale getCountriesPhones
@@ -0,0 +1 @@
appwrite locale getCountries
@@ -0,0 +1 @@
appwrite locale getCurrencies
@@ -0,0 +1 @@
appwrite locale getLanguages
@@ -0,0 +1 @@
appwrite locale get
@@ -0,0 +1 @@
appwrite storage createFile --file="" "--read[]=" "--write[]="
@@ -0,0 +1 @@
appwrite storage deleteFile --fileId="[FILE_ID]"
@@ -0,0 +1 @@
appwrite storage getFileDownload --fileId="[FILE_ID]"
@@ -0,0 +1 @@
appwrite storage getFilePreview --fileId="[FILE_ID]" --width="0" --height="0" --quality="0" --background="" --output="jpg"
@@ -0,0 +1 @@
appwrite storage getFileView --fileId="[FILE_ID]" --as="pdf"
@@ -0,0 +1 @@
appwrite storage getFile --fileId="[FILE_ID]"
@@ -0,0 +1 @@
appwrite storage listFiles --search="[SEARCH]" --limit="0" --offset="0" --orderType="ASC"
@@ -0,0 +1 @@
appwrite storage updateFile --fileId="[FILE_ID]" "--read[]=" "--write[]="
@@ -0,0 +1 @@
appwrite teams createMembership --teamId="[TEAM_ID]" --email="email@example.com" "--roles[]=" --url="https://example.com" --name="[NAME]"
@@ -0,0 +1 @@
appwrite teams create --name="[NAME]" "--roles[]="
@@ -0,0 +1 @@
appwrite teams deleteMembership --teamId="[TEAM_ID]" --inviteId="[INVITE_ID]"
@@ -0,0 +1 @@
appwrite teams delete --teamId="[TEAM_ID]"
@@ -0,0 +1 @@
appwrite teams getMemberships --teamId="[TEAM_ID]" --search="[SEARCH]" --limit="0" --offset="0" --orderType="ASC"
@@ -0,0 +1 @@
appwrite teams get --teamId="[TEAM_ID]"
@@ -0,0 +1 @@
appwrite teams list --search="[SEARCH]" --limit="0" --offset="0" --orderType="ASC"
@@ -0,0 +1 @@
appwrite teams update --teamId="[TEAM_ID]" --name="[NAME]"
@@ -0,0 +1 @@
appwrite users create --email="email@example.com" --password="password" --name="[NAME]"
@@ -0,0 +1 @@
appwrite users deleteSession --userId="[USER_ID]" --sessionId="[SESSION_ID]"
@@ -0,0 +1 @@
appwrite users deleteSessions --userId="[USER_ID]"
@@ -0,0 +1 @@
appwrite users getLogs --userId="[USER_ID]"
@@ -0,0 +1 @@
appwrite users getPrefs --userId="[USER_ID]"
@@ -0,0 +1 @@
appwrite users getSessions --userId="[USER_ID]"
@@ -0,0 +1 @@
appwrite users get --userId="[USER_ID]"
@@ -0,0 +1 @@
appwrite users list --search="[SEARCH]" --limit="0" --offset="0" --orderType="ASC"
@@ -0,0 +1 @@
appwrite users updatePrefs --userId="[USER_ID]" --prefs="{}"
@@ -0,0 +1 @@
appwrite users updateStatus --userId="[USER_ID]" --status="1"
@@ -0,0 +1 @@
appwrite avatars getBrowser --code="aa" --width="0" --height="0" --quality="0"
@@ -0,0 +1 @@
appwrite avatars getCreditCard --code="amex" --width="0" --height="0" --quality="0"
@@ -0,0 +1 @@
appwrite avatars getFavicon --url="https://example.com"
@@ -0,0 +1 @@
appwrite avatars getFlag --code="af" --width="0" --height="0" --quality="0"
@@ -0,0 +1 @@
appwrite avatars getImage --url="https://example.com" --width="0" --height="0"
@@ -0,0 +1 @@
appwrite avatars getInitials --name="[NAME]" --width="0" --height="0" --color="" --background=""
@@ -0,0 +1 @@
appwrite avatars getQR --text="[TEXT]" --size="0" --margin="0" --download=""
@@ -0,0 +1 @@
appwrite database createCollection --name="[NAME]" "--read[]=" "--write[]=" "--rules[]="
@@ -0,0 +1 @@
appwrite database createDocument --collectionId="[COLLECTION_ID]" --data="{}" "--read[]=" "--write[]=" --parentDocument="[PARENT_DOCUMENT]" --parentProperty="" --parentPropertyType="assign"
@@ -0,0 +1 @@
appwrite database deleteCollection --collectionId="[COLLECTION_ID]"
@@ -0,0 +1 @@
appwrite database deleteDocument --collectionId="[COLLECTION_ID]" --documentId="[DOCUMENT_ID]"
@@ -0,0 +1 @@
appwrite database getCollection --collectionId="[COLLECTION_ID]"
@@ -0,0 +1 @@
appwrite database getDocument --collectionId="[COLLECTION_ID]" --documentId="[DOCUMENT_ID]"
@@ -0,0 +1 @@
appwrite database listCollections --search="[SEARCH]" --limit="0" --offset="0" --orderType="ASC"
@@ -0,0 +1 @@
appwrite database listDocuments --collectionId="[COLLECTION_ID]" "--filters[]=" --limit="0" --offset="0" --orderField="[ORDER_FIELD]" --orderType="DESC" --orderCast="int" --search="[SEARCH]"
@@ -0,0 +1 @@
appwrite database updateCollection --collectionId="[COLLECTION_ID]" --name="[NAME]" "--read[]=" "--write[]=" "--rules[]="
@@ -0,0 +1 @@
appwrite database updateDocument --collectionId="[COLLECTION_ID]" --documentId="[DOCUMENT_ID]" --data="{}" "--read[]=" "--write[]="
@@ -0,0 +1 @@
appwrite functions createExecution --functionId="[FUNCTION_ID]"
@@ -0,0 +1 @@
appwrite functions createTag --functionId="[FUNCTION_ID]" --command="[COMMAND]" --code=""
@@ -0,0 +1 @@
appwrite functions create --name="[NAME]" "--execute[]=" --env="node-14.5" --vars="{}" "--events[]=" --schedule="" --timeout="1"
@@ -0,0 +1 @@
appwrite functions deleteTag --functionId="[FUNCTION_ID]" --tagId="[TAG_ID]"
@@ -0,0 +1 @@
appwrite functions delete --functionId="[FUNCTION_ID]"
@@ -0,0 +1 @@
appwrite functions getExecution --functionId="[FUNCTION_ID]" --executionId="[EXECUTION_ID]"
@@ -0,0 +1 @@
appwrite functions getTag --functionId="[FUNCTION_ID]" --tagId="[TAG_ID]"
@@ -0,0 +1 @@
appwrite functions get --functionId="[FUNCTION_ID]"
@@ -0,0 +1 @@
appwrite functions listExecutions --functionId="[FUNCTION_ID]" --search="[SEARCH]" --limit="0" --offset="0" --orderType="ASC"
@@ -0,0 +1 @@
appwrite functions listTags --functionId="[FUNCTION_ID]" --search="[SEARCH]" --limit="0" --offset="0" --orderType="ASC"
@@ -0,0 +1 @@
appwrite functions list --search="[SEARCH]" --limit="0" --offset="0" --orderType="ASC"
@@ -0,0 +1 @@
appwrite functions updateTag --functionId="[FUNCTION_ID]" --tag="[TAG]"
@@ -0,0 +1 @@
appwrite functions update --functionId="[FUNCTION_ID]" --name="[NAME]" "--execute[]=" --vars="{}" "--events[]=" --schedule="" --timeout="1"
@@ -0,0 +1 @@
appwrite health getAntiVirus
@@ -0,0 +1 @@
appwrite health getCache
@@ -0,0 +1 @@
appwrite health getDB
@@ -0,0 +1 @@
appwrite health getQueueCertificates
@@ -0,0 +1 @@
appwrite health getQueueFunctions
@@ -0,0 +1 @@
appwrite health getQueueLogs
@@ -0,0 +1 @@
appwrite health getQueueTasks
@@ -0,0 +1 @@
appwrite health getQueueUsage

Some files were not shown because too many files have changed in this diff Show More