Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Appwrite Command Line SDK

![License](https://img.shields.io/github/license/appwrite/sdk-for-cli.svg?style=flat-square)
![Version](https://img.shields.io/badge/api%20version-1.9.4-blue.svg?style=flat-square)
![Version](https://img.shields.io/badge/api%20version-1.9.5-blue.svg?style=flat-square)
[![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
[![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
[![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)

**This SDK is compatible with Appwrite server version 1.9.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-cli/releases).**
**This SDK is compatible with Appwrite server version latest. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-cli/releases).**

Appwrite 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. Use the Command Line SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)

Expand Down
10 changes: 10 additions & 0 deletions cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,22 +37,27 @@ import { generate } from './lib/commands/generate.js';
import { account } from './lib/commands/services/account.js';
import { activities } from './lib/commands/services/activities.js';
import { backups } from './lib/commands/services/backups.js';
import { compute } from './lib/commands/services/compute.js';
import { databases } from './lib/commands/services/databases.js';
import { functions } from './lib/commands/services/functions.js';
import { graphql } from './lib/commands/services/graphql.js';
import { health } from './lib/commands/services/health.js';
import { locale } from './lib/commands/services/locale.js';
import { messaging } from './lib/commands/services/messaging.js';
import { migrations } from './lib/commands/services/migrations.js';
import { organization } from './lib/commands/services/organization.js';
import { organizations } from './lib/commands/services/organizations.js';
import { presences } from './lib/commands/services/presences.js';
import { project } from './lib/commands/services/project.js';
import { projects } from './lib/commands/services/projects.js';
import { proxy } from './lib/commands/services/proxy.js';
import { advisor } from './lib/commands/services/advisor.js';
import { sites } from './lib/commands/services/sites.js';
import { storage } from './lib/commands/services/storage.js';
import { tablesDB } from './lib/commands/services/tables-db.js';
import { teams } from './lib/commands/services/teams.js';
import { tokens } from './lib/commands/services/tokens.js';
import { usage } from './lib/commands/services/usage.js';
import { users } from './lib/commands/services/users.js';
import { vcs } from './lib/commands/services/vcs.js';
import { webhooks } from './lib/commands/services/webhooks.js';
Expand Down Expand Up @@ -207,22 +212,27 @@ if (process.argv.includes('-v') || process.argv.includes('--version')) {
.addCommand(account)
.addCommand(activities)
.addCommand(backups)
.addCommand(compute)
.addCommand(databases)
.addCommand(functions)
.addCommand(graphql)
.addCommand(health)
.addCommand(locale)
.addCommand(messaging)
.addCommand(migrations)
.addCommand(organization)
.addCommand(organizations)
.addCommand(presences)
.addCommand(project)
.addCommand(projects)
.addCommand(proxy)
.addCommand(advisor)
.addCommand(sites)
.addCommand(storage)
.addCommand(tablesDB)
.addCommand(teams)
.addCommand(tokens)
.addCommand(usage)
.addCommand(users)
.addCommand(vcs)
.addCommand(webhooks)
Expand Down
4 changes: 4 additions & 0 deletions docs/examples/advisor/delete-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite advisor delete-report \
--report-id <REPORT_ID>
```
5 changes: 5 additions & 0 deletions docs/examples/advisor/get-insight.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```bash
appwrite advisor get-insight \
--report-id <REPORT_ID> \
--insight-id <INSIGHT_ID>
```
4 changes: 4 additions & 0 deletions docs/examples/advisor/get-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite advisor get-report \
--report-id <REPORT_ID>
```
5 changes: 5 additions & 0 deletions docs/examples/advisor/list-insights.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```bash
appwrite advisor list-insights \
--report-id <REPORT_ID> \
--limit 25
```
4 changes: 4 additions & 0 deletions docs/examples/advisor/list-reports.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite advisor list-reports \
--limit 25
```
4 changes: 4 additions & 0 deletions docs/examples/compute/create-database-backup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute create-database-backup \
--database-id <DATABASE_ID>
```
4 changes: 4 additions & 0 deletions docs/examples/compute/create-database-branch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute create-database-branch \
--database-id <DATABASE_ID>
```
5 changes: 5 additions & 0 deletions docs/examples/compute/create-database-connection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```bash
appwrite compute create-database-connection \
--database-id <DATABASE_ID> \
--username <USERNAME>
```
5 changes: 5 additions & 0 deletions docs/examples/compute/create-database-execution.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```bash
appwrite compute create-database-execution \
--database-id <DATABASE_ID> \
--sql <SQL>
```
5 changes: 5 additions & 0 deletions docs/examples/compute/create-database-extension.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```bash
appwrite compute create-database-extension \
--database-id <DATABASE_ID> \
--name <NAME>
```
4 changes: 4 additions & 0 deletions docs/examples/compute/create-database-failover.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute create-database-failover \
--database-id <DATABASE_ID>
```
5 changes: 5 additions & 0 deletions docs/examples/compute/create-database-migration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```bash
appwrite compute create-database-migration \
--database-id <DATABASE_ID> \
--target-type shared
```
5 changes: 5 additions & 0 deletions docs/examples/compute/create-database-query-explanation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```bash
appwrite compute create-database-query-explanation \
--database-id <DATABASE_ID> \
--query <QUERY>
```
4 changes: 4 additions & 0 deletions docs/examples/compute/create-database-restoration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute create-database-restoration \
--database-id <DATABASE_ID>
```
5 changes: 5 additions & 0 deletions docs/examples/compute/create-database-schema-preview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```bash
appwrite compute create-database-schema-preview \
--database-id <DATABASE_ID> \
--sql <SQL>
```
5 changes: 5 additions & 0 deletions docs/examples/compute/create-database-upgrade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```bash
appwrite compute create-database-upgrade \
--database-id <DATABASE_ID> \
--target-version <TARGET_VERSION>
```
5 changes: 5 additions & 0 deletions docs/examples/compute/create-database.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```bash
appwrite compute create-database \
--database-id <DATABASE_ID> \
--name <NAME>
```
5 changes: 5 additions & 0 deletions docs/examples/compute/delete-database-backup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```bash
appwrite compute delete-database-backup \
--database-id <DATABASE_ID> \
--backup-id <BACKUP_ID>
```
5 changes: 5 additions & 0 deletions docs/examples/compute/delete-database-branch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```bash
appwrite compute delete-database-branch \
--database-id <DATABASE_ID> \
--branch-id <BRANCH_ID>
```
5 changes: 5 additions & 0 deletions docs/examples/compute/delete-database-connection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```bash
appwrite compute delete-database-connection \
--database-id <DATABASE_ID> \
--connection-id <CONNECTION_ID>
```
5 changes: 5 additions & 0 deletions docs/examples/compute/delete-database-extension.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```bash
appwrite compute delete-database-extension \
--database-id <DATABASE_ID> \
--extension-name <EXTENSION_NAME>
```
4 changes: 4 additions & 0 deletions docs/examples/compute/delete-database.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute delete-database \
--database-id <DATABASE_ID>
```
5 changes: 5 additions & 0 deletions docs/examples/compute/get-database-backup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```bash
appwrite compute get-database-backup \
--database-id <DATABASE_ID> \
--backup-id <BACKUP_ID>
```
4 changes: 4 additions & 0 deletions docs/examples/compute/get-database-credentials.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute get-database-credentials \
--database-id <DATABASE_ID>
```
4 changes: 4 additions & 0 deletions docs/examples/compute/get-database-ha-status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute get-database-ha-status \
--database-id <DATABASE_ID>
```
4 changes: 4 additions & 0 deletions docs/examples/compute/get-database-insights.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute get-database-insights \
--database-id <DATABASE_ID>
```
4 changes: 4 additions & 0 deletions docs/examples/compute/get-database-metrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute get-database-metrics \
--database-id <DATABASE_ID>
```
4 changes: 4 additions & 0 deletions docs/examples/compute/get-database-pitr-windows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute get-database-pitr-windows \
--database-id <DATABASE_ID>
```
4 changes: 4 additions & 0 deletions docs/examples/compute/get-database-pooler.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute get-database-pooler \
--database-id <DATABASE_ID>
```
5 changes: 5 additions & 0 deletions docs/examples/compute/get-database-restoration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```bash
appwrite compute get-database-restoration \
--database-id <DATABASE_ID> \
--restoration-id <RESTORATION_ID>
```
4 changes: 4 additions & 0 deletions docs/examples/compute/get-database-schema.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute get-database-schema \
--database-id <DATABASE_ID>
```
4 changes: 4 additions & 0 deletions docs/examples/compute/get-database-status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute get-database-status \
--database-id <DATABASE_ID>
```
4 changes: 4 additions & 0 deletions docs/examples/compute/get-database-usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute get-database-usage \
--database-id <DATABASE_ID>
```
4 changes: 4 additions & 0 deletions docs/examples/compute/get-database.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute get-database \
--database-id <DATABASE_ID>
```
5 changes: 5 additions & 0 deletions docs/examples/compute/list-database-backups.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```bash
appwrite compute list-database-backups \
--database-id <DATABASE_ID> \
--limit 25
```
4 changes: 4 additions & 0 deletions docs/examples/compute/list-database-branches.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute list-database-branches \
--database-id <DATABASE_ID>
```
4 changes: 4 additions & 0 deletions docs/examples/compute/list-database-connections.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute list-database-connections \
--database-id <DATABASE_ID>
```
4 changes: 4 additions & 0 deletions docs/examples/compute/list-database-extensions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute list-database-extensions \
--database-id <DATABASE_ID>
```
4 changes: 4 additions & 0 deletions docs/examples/compute/list-database-logs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute list-database-logs \
--database-id <DATABASE_ID>
```
4 changes: 4 additions & 0 deletions docs/examples/compute/list-database-queries.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute list-database-queries \
--database-id <DATABASE_ID>
```
4 changes: 4 additions & 0 deletions docs/examples/compute/list-database-restorations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute list-database-restorations \
--database-id <DATABASE_ID>
```
4 changes: 4 additions & 0 deletions docs/examples/compute/list-databases.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute list-databases \
--limit 25
```
8 changes: 8 additions & 0 deletions docs/examples/compute/update-database-backup-storage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
```bash
appwrite compute update-database-backup-storage \
--database-id <DATABASE_ID> \
--provider s3 \
--bucket <BUCKET> \
--access-key <ACCESS_KEY> \
--secret-key <SECRET_KEY>
```
4 changes: 4 additions & 0 deletions docs/examples/compute/update-database-credentials.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute update-database-credentials \
--database-id <DATABASE_ID>
```
6 changes: 6 additions & 0 deletions docs/examples/compute/update-database-maintenance-window.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
```bash
appwrite compute update-database-maintenance-window \
--database-id <DATABASE_ID> \
--day sun \
--hour-utc 0
```
4 changes: 4 additions & 0 deletions docs/examples/compute/update-database-pooler.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute update-database-pooler \
--database-id <DATABASE_ID>
```
4 changes: 4 additions & 0 deletions docs/examples/compute/update-database.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite compute update-database \
--database-id <DATABASE_ID>
```
6 changes: 6 additions & 0 deletions docs/examples/organization/create-key.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
```bash
appwrite organization create-key \
--key-id <KEY_ID> \
--name <NAME> \
--scopes one two three
```
5 changes: 5 additions & 0 deletions docs/examples/organization/create-project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```bash
appwrite organization create-project \
--project-id '' \
--name <NAME>
```
4 changes: 4 additions & 0 deletions docs/examples/organization/delete-key.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite organization delete-key \
--key-id <KEY_ID>
```
4 changes: 4 additions & 0 deletions docs/examples/organization/delete-project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite organization delete-project \
--project-id <PROJECT_ID>
```
4 changes: 4 additions & 0 deletions docs/examples/organization/get-key.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite organization get-key \
--key-id <KEY_ID>
```
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
```bash
appwrite projects get \
appwrite organization get-project \
--project-id <PROJECT_ID>
```
4 changes: 4 additions & 0 deletions docs/examples/organization/list-keys.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite organization list-keys \
--limit 25
```
4 changes: 4 additions & 0 deletions docs/examples/organization/list-projects.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```bash
appwrite organization list-projects \
--limit 25
```
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
```bash
appwrite organizations update-key \
--organization-id <ORGANIZATION_ID> \
appwrite organization update-key \
--key-id <KEY_ID> \
--name <NAME> \
--scopes one two three
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
```bash
appwrite projects update \
appwrite organization update-project \
--project-id <PROJECT_ID> \
--name <NAME>
```
6 changes: 0 additions & 6 deletions docs/examples/organizations/create-key.md

This file was deleted.

Loading