Skip to content

docs: refresh README #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ChiragAgg5k merged 3 commits into from
Oct 17, 2026
Merged

docs: refresh README #17

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d063456
chore: update AgentSkills SDK to 0.3.0
ChiragAgg5k Aug 18, 2026
646392f
Merge commit 'd063456fd32330d3ff3ca5422c1d8b89e969b318' into dev
ChiragAgg5k Oct 17, 2026
e4246f6
docs: refresh README
ChiragAgg5k Oct 17, 2026
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
82 changes: 49 additions & 33 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,53 +1,57 @@
# Appwrite AgentSkills
# Appwrite Agent Skills

![License](https://img.shields.io/github/license/appwrite/agent-skills.svg?style=flat-square)
![Version](https://img.shields.io/badge/api%20version-1.9.x-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)
![License](https://img.shields.io/badge/license-BSD--3--Clause-blue.svg?style=flat-square)
![Version](https://img.shields.io/badge/api%20version-2.5.x-blue.svg?style=flat-square)
[![X Account](https://img.shields.io/badge/follow-%40appwrite-000000?logo=x&style=flat-square)](https://x.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/agent-skills.git/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 AgentSkills 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)
Appwrite skills for AI coding agents such as Claude Code, Cursor, Codex, GitHub Copilot, and Zed. Each skill gives the agent current, language-specific guidance for building with Appwrite: client setup, authentication, TablesDB queries, storage, realtime, functions, and the Appwrite CLI. The skills follow the [Agent Skills](https://agentskills.io) open standard.

![Appwrite](https://github.com/appwrite/appwrite/raw/main/public/images/github.png)

## Installation

## Getting Started

Agent Skills to help developers using AI coding agents with Appwrite. Agent Skills are folders of instructions, scripts, and resources that agents like Claude Code, Cursor, GitHub Copilot, and others can discover and use to work more accurately and efficiently.
Install the skills with the [Skills CLI](https://github.com/vercel-labs/skills):

These skills follow the Agent Skills Open Standard: https://agentskills.io/home

### Install the skills
```bash
npx skills add appwrite/skills
```

Install directly with the Skills CLI:
The CLI asks which skills to install, which agents should use them, and whether to install them in the current project or globally. To skip the prompts, pass the choices as flags:

```bash
npx skills add appwrite/agent-skills
npx skills add appwrite/skills --skill appwrite-typescript --skill appwrite-cli --agent claude-code --global --yes
```

This installs the packaged `appwrite-*` skills into your local skills directory.
Run `npx skills add appwrite/skills --list` to see every skill in the repository without installing anything.

### Available language skills
If you use Claude Code, Cursor, or Codex, the Appwrite plugin for that tool bundles these skills together with the hosted Appwrite MCP server:

- `appwrite-typescript`
- `appwrite-dart`
- `appwrite-kotlin`
- `appwrite-swift`
- `appwrite-php`
- `appwrite-python`
- `appwrite-ruby`
- `appwrite-go`
- `appwrite-dotnet`
- [Claude Code plugin](https://github.com/appwrite/claude-plugin)
- [Cursor plugin](https://github.com/appwrite/cursor-plugin)
- [Codex plugin](https://github.com/appwrite/codex-plugin)

### Usage
## Available skills

Skills are automatically available once installed. The agent will use them when relevant tasks are detected.
| Skill | Use it for |
| --- | --- |
| `appwrite-typescript` | Web, React Native, Node.js, and Deno apps |
| `appwrite-dart` | Flutter apps and Dart servers |
| `appwrite-kotlin` | Android apps and Kotlin/JVM servers |
| `appwrite-swift` | Apple platform apps and Swift servers |
| `appwrite-php` | PHP servers, including Laravel and Symfony |
| `appwrite-python` | Python servers, including Django, Flask, and FastAPI |
| `appwrite-ruby` | Ruby servers, including Rails and Sinatra |
| `appwrite-go` | Go servers |
| `appwrite-rust` | Rust servers |
| `appwrite-dotnet` | C# and .NET servers |
| `appwrite-cli` | The Appwrite CLI: project config, deployments, and code generation |

### Prompt examples
## Usage

Use these as copy-paste prompt starters.
Agents load a skill automatically when a task matches its description. To make sure a specific skill is used, name it in your prompt.

### Prompt examples

#### TypeScript (server-side)

Expand Down Expand Up @@ -90,7 +94,7 @@ Prefer dependency injection for the Appwrite client.

```text
Use the appwrite-go skill.
Implement a CLI command that creates a document-style row, then reads it back and prints JSON output.
Implement a CLI command that creates a row in TablesDB, then reads it back and prints JSON output.
Use context timeouts and structured error messages.
```

Expand All @@ -102,6 +106,13 @@ Generate Android repository code to paginate rows using cursor queries and expos
Keep UI concerns out of the data layer.
```

#### Appwrite CLI

```text
Use the appwrite-cli skill.
Pull the functions in my project, add a new Node.js function that runs on a schedule, and deploy it.
```

#### Migration prompt (Databases -> TablesDB)

```text
Expand All @@ -110,10 +121,15 @@ Migrate this existing Databases-based code to TablesDB APIs.
Keep behavior identical and list each API mapping you changed.
```

## Learn more

- [Appwrite skills documentation](https://appwrite.io/docs/tooling/ai/skills)
- [Appwrite MCP server](https://appwrite.io/docs/tooling/ai/mcp-servers)
- [Agent Skills specification](https://agentskills.io)

## Contribution

This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.
This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/main/CONTRIBUTING.md) before sending a pull-request.

## License

Expand Down