data
Appwrite CLI for AI Agents
Use the Appwrite CLI from KosmoKrator to call Appwrite tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.Appwrite CLI Setup
Appwrite can be configured headlessly with `kosmokrator integrations:configure appwrite`.
# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash
# Configure and verify this integration.
kosmokrator integrations:configure appwrite --set api_key="$APPWRITE_API_KEY" --set project_id="$APPWRITE_PROJECT_ID" --enable --read allow --write ask --json
kosmokrator integrations:doctor appwrite --json
kosmokrator integrations:status --json Credentials
Authentication type: API key api_key. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.
| Key | Env var | Type | Required | Label |
|---|---|---|---|---|
api_key | APPWRITE_API_KEY | Secret secret | yes | API Key |
project_id | APPWRITE_PROJECT_ID | Text text | yes | Project ID |
url | APPWRITE_URL | URL url | no | Server URL |
Command Patterns
The generic command is stable across every integration. The provider shortcut is shorter for humans.
kosmo integrations:call appwrite.appwrite_list_databases '{"queries":"example_queries","search":"example_search","total":true,"limit":1,"offset":1}' --json kosmo integrations:appwrite appwrite_list_databases '{"queries":"example_queries","search":"example_search","total":true,"limit":1,"offset":1}' --json Discovery
These commands return structured output for coding agents that need to inspect capabilities before choosing a function.
kosmo integrations:docs appwrite --json
kosmo integrations:docs appwrite.appwrite_list_databases --json
kosmo integrations:schema appwrite.appwrite_list_databases --json
kosmo integrations:search "Appwrite" --json
kosmo integrations:list --json Automation Contexts
The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.
CLI Functions
Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.
appwrite.appwrite_list_databases
List all databases in the Appwrite project. Returns database IDs and names.
read - Parameters
- queries, search, total, limit, offset
kosmo integrations:call appwrite.appwrite_list_databases '{"queries":"example_queries","search":"example_search","total":true,"limit":1,"offset":1}' --json kosmo integrations:appwrite appwrite_list_databases '{"queries":"example_queries","search":"example_search","total":true,"limit":1,"offset":1}' --json appwrite.appwrite_create_database
Create a database in the Appwrite project.
write - Parameters
- none
kosmo integrations:call appwrite.appwrite_create_database '{}' --json kosmo integrations:appwrite appwrite_create_database '{}' --json appwrite.appwrite_get_database
Get details of a specific Appwrite database by its ID.
read - Parameters
- id
kosmo integrations:call appwrite.appwrite_get_database '{"id":"example_id"}' --json kosmo integrations:appwrite appwrite_get_database '{"id":"example_id"}' --json appwrite.appwrite_update_database
Update a database name or enabled state.
write - Parameters
- none
kosmo integrations:call appwrite.appwrite_update_database '{}' --json kosmo integrations:appwrite appwrite_update_database '{}' --json appwrite.appwrite_delete_database
Delete a database by ID.
write - Parameters
- none
kosmo integrations:call appwrite.appwrite_delete_database '{}' --json kosmo integrations:appwrite appwrite_delete_database '{}' --json appwrite.appwrite_list_collections
List all collections in an Appwrite database. Returns collection IDs and names.
read - Parameters
- database_id, queries, search, total, limit, offset
kosmo integrations:call appwrite.appwrite_list_collections '{"database_id":"example_database_id","queries":"example_queries","search":"example_search","total":true,"limit":1,"offset":1}' --json kosmo integrations:appwrite appwrite_list_collections '{"database_id":"example_database_id","queries":"example_queries","search":"example_search","total":true,"limit":1,"offset":1}' --json appwrite.appwrite_create_collection
Create a collection in a database.
write - Parameters
- none
kosmo integrations:call appwrite.appwrite_create_collection '{}' --json kosmo integrations:appwrite appwrite_create_collection '{}' --json appwrite.appwrite_get_collection
Get details for a collection.
read - Parameters
- none
kosmo integrations:call appwrite.appwrite_get_collection '{}' --json kosmo integrations:appwrite appwrite_get_collection '{}' --json appwrite.appwrite_update_collection
Update collection metadata and permissions.
write - Parameters
- none
kosmo integrations:call appwrite.appwrite_update_collection '{}' --json kosmo integrations:appwrite appwrite_update_collection '{}' --json appwrite.appwrite_delete_collection
Delete a collection from a database.
write - Parameters
- none
kosmo integrations:call appwrite.appwrite_delete_collection '{}' --json kosmo integrations:appwrite appwrite_delete_collection '{}' --json appwrite.appwrite_list_documents
List documents in an Appwrite collection. Returns document data and metadata.
read - Parameters
- database_id, collection_id, queries, total, limit, offset
kosmo integrations:call appwrite.appwrite_list_documents '{"database_id":"example_database_id","collection_id":"example_collection_id","queries":"example_queries","total":true,"limit":1,"offset":1}' --json kosmo integrations:appwrite appwrite_list_documents '{"database_id":"example_database_id","collection_id":"example_collection_id","queries":"example_queries","total":true,"limit":1,"offset":1}' --json appwrite.appwrite_get_document
Get a single document from an Appwrite collection by its ID.
read - Parameters
- database_id, collection_id, doc_id
kosmo integrations:call appwrite.appwrite_get_document '{"database_id":"example_database_id","collection_id":"example_collection_id","doc_id":"example_doc_id"}' --json kosmo integrations:appwrite appwrite_get_document '{"database_id":"example_database_id","collection_id":"example_collection_id","doc_id":"example_doc_id"}' --json appwrite.appwrite_create_document
Create a new document in an Appwrite collection.
write - Parameters
- database_id, collection_id, document_id, data
kosmo integrations:call appwrite.appwrite_create_document '{"database_id":"example_database_id","collection_id":"example_collection_id","document_id":"example_document_id","data":"example_data"}' --json kosmo integrations:appwrite appwrite_create_document '{"database_id":"example_database_id","collection_id":"example_collection_id","document_id":"example_document_id","data":"example_data"}' --json appwrite.appwrite_update_document
Update a document data payload.
write - Parameters
- none
kosmo integrations:call appwrite.appwrite_update_document '{}' --json kosmo integrations:appwrite appwrite_update_document '{}' --json appwrite.appwrite_delete_document
Delete a document from a collection.
write - Parameters
- none
kosmo integrations:call appwrite.appwrite_delete_document '{}' --json kosmo integrations:appwrite appwrite_delete_document '{}' --json appwrite.appwrite_get_current_user
Get the currently authenticated Appwrite user account information.
read - Parameters
- none
kosmo integrations:call appwrite.appwrite_get_current_user '{}' --json kosmo integrations:appwrite appwrite_get_current_user '{}' --json appwrite.appwrite_list_users
List users in the Appwrite project.
read - Parameters
- none
kosmo integrations:call appwrite.appwrite_list_users '{}' --json kosmo integrations:appwrite appwrite_list_users '{}' --json appwrite.appwrite_get_user
Get one Appwrite user by ID.
read - Parameters
- none
kosmo integrations:call appwrite.appwrite_get_user '{}' --json kosmo integrations:appwrite appwrite_get_user '{}' --json appwrite.appwrite_create_user
Create a user in the Appwrite project.
write - Parameters
- none
kosmo integrations:call appwrite.appwrite_create_user '{}' --json kosmo integrations:appwrite appwrite_create_user '{}' --json appwrite.appwrite_update_user_status
Enable or disable an Appwrite user.
write - Parameters
- none
kosmo integrations:call appwrite.appwrite_update_user_status '{}' --json kosmo integrations:appwrite appwrite_update_user_status '{}' --json appwrite.appwrite_delete_user
Delete an Appwrite user.
write - Parameters
- none
kosmo integrations:call appwrite.appwrite_delete_user '{}' --json kosmo integrations:appwrite appwrite_delete_user '{}' --json appwrite.appwrite_list_teams
List teams in the Appwrite project.
read - Parameters
- none
kosmo integrations:call appwrite.appwrite_list_teams '{}' --json kosmo integrations:appwrite appwrite_list_teams '{}' --json appwrite.appwrite_get_team
Get one Appwrite team by ID.
read - Parameters
- none
kosmo integrations:call appwrite.appwrite_get_team '{}' --json kosmo integrations:appwrite appwrite_get_team '{}' --json appwrite.appwrite_create_team
Create a team in the Appwrite project.
write - Parameters
- none
kosmo integrations:call appwrite.appwrite_create_team '{}' --json kosmo integrations:appwrite appwrite_create_team '{}' --json appwrite.appwrite_delete_team
Delete an Appwrite team.
write - Parameters
- none
kosmo integrations:call appwrite.appwrite_delete_team '{}' --json kosmo integrations:appwrite appwrite_delete_team '{}' --json appwrite.appwrite_list_team_memberships
List memberships for a team.
read - Parameters
- none
kosmo integrations:call appwrite.appwrite_list_team_memberships '{}' --json kosmo integrations:appwrite appwrite_list_team_memberships '{}' --json appwrite.appwrite_list_buckets
List Appwrite storage buckets.
read - Parameters
- none
kosmo integrations:call appwrite.appwrite_list_buckets '{}' --json kosmo integrations:appwrite appwrite_list_buckets '{}' --json appwrite.appwrite_get_bucket
Get one Appwrite storage bucket.
read - Parameters
- none
kosmo integrations:call appwrite.appwrite_get_bucket '{}' --json kosmo integrations:appwrite appwrite_get_bucket '{}' --json appwrite.appwrite_create_bucket
Create an Appwrite storage bucket.
write - Parameters
- none
kosmo integrations:call appwrite.appwrite_create_bucket '{}' --json kosmo integrations:appwrite appwrite_create_bucket '{}' --json appwrite.appwrite_update_bucket
Update an Appwrite storage bucket.
write - Parameters
- none
kosmo integrations:call appwrite.appwrite_update_bucket '{}' --json kosmo integrations:appwrite appwrite_update_bucket '{}' --json appwrite.appwrite_delete_bucket
Delete an Appwrite storage bucket.
write - Parameters
- none
kosmo integrations:call appwrite.appwrite_delete_bucket '{}' --json kosmo integrations:appwrite appwrite_delete_bucket '{}' --json appwrite.appwrite_list_files
List files in a storage bucket.
read - Parameters
- none
kosmo integrations:call appwrite.appwrite_list_files '{}' --json kosmo integrations:appwrite appwrite_list_files '{}' --json appwrite.appwrite_get_file
Get Appwrite storage file metadata.
read - Parameters
- none
kosmo integrations:call appwrite.appwrite_get_file '{}' --json kosmo integrations:appwrite appwrite_get_file '{}' --json appwrite.appwrite_delete_file
Delete a file from a storage bucket.
write - Parameters
- none
kosmo integrations:call appwrite.appwrite_delete_file '{}' --json kosmo integrations:appwrite appwrite_delete_file '{}' --json appwrite.appwrite_list_functions
List Appwrite functions.
read - Parameters
- none
kosmo integrations:call appwrite.appwrite_list_functions '{}' --json kosmo integrations:appwrite appwrite_list_functions '{}' --json appwrite.appwrite_get_function
Get one Appwrite function by ID.
read - Parameters
- none
kosmo integrations:call appwrite.appwrite_get_function '{}' --json kosmo integrations:appwrite appwrite_get_function '{}' --json appwrite.appwrite_create_execution
Execute an Appwrite function.
write - Parameters
- none
kosmo integrations:call appwrite.appwrite_create_execution '{}' --json kosmo integrations:appwrite appwrite_create_execution '{}' --json appwrite.appwrite_list_executions
List executions for an Appwrite function.
read - Parameters
- none
kosmo integrations:call appwrite.appwrite_list_executions '{}' --json kosmo integrations:appwrite appwrite_list_executions '{}' --json appwrite.appwrite_get_execution
Get one Appwrite function execution.
read - Parameters
- none
kosmo integrations:call appwrite.appwrite_get_execution '{}' --json kosmo integrations:appwrite appwrite_get_execution '{}' --json appwrite.appwrite_list_messaging_providers
List Appwrite messaging providers.
read - Parameters
- none
kosmo integrations:call appwrite.appwrite_list_messaging_providers '{}' --json kosmo integrations:appwrite appwrite_list_messaging_providers '{}' --json appwrite.appwrite_list_topics
List Appwrite messaging topics.
read - Parameters
- none
kosmo integrations:call appwrite.appwrite_list_topics '{}' --json kosmo integrations:appwrite appwrite_list_topics '{}' --json appwrite.appwrite_create_topic
Create an Appwrite messaging topic.
write - Parameters
- none
kosmo integrations:call appwrite.appwrite_create_topic '{}' --json kosmo integrations:appwrite appwrite_create_topic '{}' --json appwrite.appwrite_delete_topic
Delete an Appwrite messaging topic.
write - Parameters
- none
kosmo integrations:call appwrite.appwrite_delete_topic '{}' --json kosmo integrations:appwrite appwrite_delete_topic '{}' --json appwrite.appwrite_list_messages
List Appwrite messaging messages.
read - Parameters
- none
kosmo integrations:call appwrite.appwrite_list_messages '{}' --json kosmo integrations:appwrite appwrite_list_messages '{}' --json appwrite.appwrite_create_email
Create an Appwrite email message.
write - Parameters
- none
kosmo integrations:call appwrite.appwrite_create_email '{}' --json kosmo integrations:appwrite appwrite_create_email '{}' --json appwrite.appwrite_create_push
Create an Appwrite push notification.
write - Parameters
- none
kosmo integrations:call appwrite.appwrite_create_push '{}' --json kosmo integrations:appwrite appwrite_create_push '{}' --json Function Schemas
Use these parameter tables when building CLI payloads without calling integrations:schema first.
appwrite.appwrite_list_databases 5 parameters
kosmo integrations:schema appwrite.appwrite_list_databases --json | Parameter | Type | Required | Description |
|---|---|---|---|
queries | array | no | Appwrite Query strings for filtering and pagination. |
search | string | no | Search term to filter databases by name. |
total | boolean | no | Whether Appwrite should calculate total count. |
limit | integer | no | Compatibility helper that is converted to an Appwrite limit() query. |
offset | integer | no | Compatibility helper that is converted to an Appwrite offset() query. |
appwrite.appwrite_create_database 0 parameters
kosmo integrations:schema appwrite.appwrite_create_database --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_get_database 1 parameters
kosmo integrations:schema appwrite.appwrite_get_database --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The database ID. |
appwrite.appwrite_update_database 0 parameters
kosmo integrations:schema appwrite.appwrite_update_database --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_delete_database 0 parameters
kosmo integrations:schema appwrite.appwrite_delete_database --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_list_collections 6 parameters
kosmo integrations:schema appwrite.appwrite_list_collections --json | Parameter | Type | Required | Description |
|---|---|---|---|
database_id | string | yes | The database ID to list collections from. |
queries | array | no | Appwrite Query strings for filtering and pagination. |
search | string | no | Search term to filter collections by name. |
total | boolean | no | Whether Appwrite should calculate total count. |
limit | integer | no | Compatibility helper that is converted to an Appwrite limit() query. |
offset | integer | no | Compatibility helper that is converted to an Appwrite offset() query. |
appwrite.appwrite_create_collection 0 parameters
kosmo integrations:schema appwrite.appwrite_create_collection --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_get_collection 0 parameters
kosmo integrations:schema appwrite.appwrite_get_collection --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_update_collection 0 parameters
kosmo integrations:schema appwrite.appwrite_update_collection --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_delete_collection 0 parameters
kosmo integrations:schema appwrite.appwrite_delete_collection --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_list_documents 6 parameters
kosmo integrations:schema appwrite.appwrite_list_documents --json | Parameter | Type | Required | Description |
|---|---|---|---|
database_id | string | yes | The database ID. |
collection_id | string | yes | The collection ID. |
queries | array | no | Appwrite Query strings for filtering and pagination. |
total | boolean | no | Whether Appwrite should calculate total count. |
limit | integer | no | Compatibility helper that is converted to an Appwrite limit() query. |
offset | integer | no | Compatibility helper that is converted to an Appwrite offset() query. |
appwrite.appwrite_get_document 3 parameters
kosmo integrations:schema appwrite.appwrite_get_document --json | Parameter | Type | Required | Description |
|---|---|---|---|
database_id | string | yes | The database ID. |
collection_id | string | yes | The collection ID. |
doc_id | string | yes | The document ID. |
appwrite.appwrite_create_document 4 parameters
kosmo integrations:schema appwrite.appwrite_create_document --json | Parameter | Type | Required | Description |
|---|---|---|---|
database_id | string | yes | The database ID. |
collection_id | string | yes | The collection ID. |
document_id | string | yes | A unique ID for the document (use "unique()" to auto-generate). |
data | object | yes | The document data as key-value pairs matching the collection attributes. |
appwrite.appwrite_update_document 0 parameters
kosmo integrations:schema appwrite.appwrite_update_document --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_delete_document 0 parameters
kosmo integrations:schema appwrite.appwrite_delete_document --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_get_current_user 0 parameters
kosmo integrations:schema appwrite.appwrite_get_current_user --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_list_users 0 parameters
kosmo integrations:schema appwrite.appwrite_list_users --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_get_user 0 parameters
kosmo integrations:schema appwrite.appwrite_get_user --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_create_user 0 parameters
kosmo integrations:schema appwrite.appwrite_create_user --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_update_user_status 0 parameters
kosmo integrations:schema appwrite.appwrite_update_user_status --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_delete_user 0 parameters
kosmo integrations:schema appwrite.appwrite_delete_user --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_list_teams 0 parameters
kosmo integrations:schema appwrite.appwrite_list_teams --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_get_team 0 parameters
kosmo integrations:schema appwrite.appwrite_get_team --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_create_team 0 parameters
kosmo integrations:schema appwrite.appwrite_create_team --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_delete_team 0 parameters
kosmo integrations:schema appwrite.appwrite_delete_team --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_list_team_memberships 0 parameters
kosmo integrations:schema appwrite.appwrite_list_team_memberships --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_list_buckets 0 parameters
kosmo integrations:schema appwrite.appwrite_list_buckets --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_get_bucket 0 parameters
kosmo integrations:schema appwrite.appwrite_get_bucket --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_create_bucket 0 parameters
kosmo integrations:schema appwrite.appwrite_create_bucket --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_update_bucket 0 parameters
kosmo integrations:schema appwrite.appwrite_update_bucket --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_delete_bucket 0 parameters
kosmo integrations:schema appwrite.appwrite_delete_bucket --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_list_files 0 parameters
kosmo integrations:schema appwrite.appwrite_list_files --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_get_file 0 parameters
kosmo integrations:schema appwrite.appwrite_get_file --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_delete_file 0 parameters
kosmo integrations:schema appwrite.appwrite_delete_file --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_list_functions 0 parameters
kosmo integrations:schema appwrite.appwrite_list_functions --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_get_function 0 parameters
kosmo integrations:schema appwrite.appwrite_get_function --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_create_execution 0 parameters
kosmo integrations:schema appwrite.appwrite_create_execution --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_list_executions 0 parameters
kosmo integrations:schema appwrite.appwrite_list_executions --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_get_execution 0 parameters
kosmo integrations:schema appwrite.appwrite_get_execution --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_list_messaging_providers 0 parameters
kosmo integrations:schema appwrite.appwrite_list_messaging_providers --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_list_topics 0 parameters
kosmo integrations:schema appwrite.appwrite_list_topics --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_create_topic 0 parameters
kosmo integrations:schema appwrite.appwrite_create_topic --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_delete_topic 0 parameters
kosmo integrations:schema appwrite.appwrite_delete_topic --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_list_messages 0 parameters
kosmo integrations:schema appwrite.appwrite_list_messages --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_create_email 0 parameters
kosmo integrations:schema appwrite.appwrite_create_email --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
appwrite.appwrite_create_push 0 parameters
kosmo integrations:schema appwrite.appwrite_create_push --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
Permissions
Headless calls still follow the integration read/write permission policy. Configure read/write defaults with
integrations:configure. Add --force only for trusted automation that should bypass that policy.