Pylon

https://www.pylonsync.com/docs
Admin
Pylon is a realtime backend for React Native and Swift apps with schema, server functions, live...
Tokens:2,189
Snippets:48
Trust Score:3.4
Update:4 months ago
Show doc for...
Tokens:
Raw
### Starting Pylon Development Server

Source: https://www.pylonsync.com

Navigates into the project directory and starts the Pylon development server. Displays API, web, and studio URLs, and indicates schema sync status.

```bash
❯ cd my-app && pylon dev
→ api http://localhost:4321
→ web http://localhost:3000
→ studio http://localhost:4321/studio
✓ Schema synced · 0 conflicts
◉ Live · 0 clients · listening
```

--------------------------------

### Install Pylon Skill

Source: https://www.pylonsync.com

Installs the Pylon skill for Claude Code by creating a directory and downloading the skill markdown file. Restart Claude Code for the skill to auto-load.

```bash
mkdir -p ~/.claude/skills/pylon
curl -fsSL https://pylonsync.com/pylon-skill.md \
> ~/.claude/skills/pylon/SKILL.md
```

--------------------------------

### Local Development with Pylon

Source: https://www.pylonsync.com

Starts a local Pylon development server with hot reloading and type-safe client regeneration. Uses SQLite as the default database.

```bash
$ pylon dev
```

--------------------------------

### React Query Hook Example

Source: https://www.pylonsync.com

Demonstrates using the `useQuery` hook in React to subscribe to data changes. Queries re-run on relevant writes, and optimistic mutations are supported with auto-rollback.

```javascript
db.useQuery("Order")
```

--------------------------------

### Scaffolding a New Pylon Project

Source: https://www.pylonsync.com

Creates a new Pylon project with a backend and Next.js frontend using npm. Installs necessary packages without global binaries or toolchains.

```bash
❯ npm create @pylonsync/pylon@latest my-app
Creating my-app in ./my-app
✓ Scaffolded api/ + web/ + shared schema
✓ Installed @pylonsync/cli, sdk, react
```

--------------------------------

### Deploying to Pylon Cloud

Source: https://www.pylonsync.com

Deploys the Pylon application to Pylon Cloud for managed hosting. Uses the same binary and APIs as local development.

```bash
$ pylon deploy
```

--------------------------------

### Create Pylon Project Locally

Source: https://www.pylonsync.com

Creates a new Pylon project locally using npm. This command initializes a new Pylon application.

```bash
npm create @pylonsync/pylon@latest
```

--------------------------------

### Realtime Orders Dashboard with `db.useQuery`

Source: https://www.pylonsync.com

This snippet demonstrates how to fetch and stream live order data for a dashboard using PylonSync's `db.useQuery`. The query automatically re-runs on data writes without manual polling or invalidation.

```typescript
const { data: orders } =
  db.useQuery("Order", {
    where: { status: "paid" },
    order: "desc",
    limit: 50,
  });

// re-runs on every write,
// no polling, no invalidation
```

--------------------------------

### Running Pylon in a Docker Container

Source: https://www.pylonsync.com

Runs the Pylon binary within a Docker container for self-hosting on various platforms. Suitable for VPS, container platforms, or private networks.

```bash
$ docker run pylon
```

--------------------------------

### Swift SDK Codegen Command

Source: https://www.pylonsync.com

Generates a first-class Swift SDK from the Pylon schema, providing TypeScript-sync parity and a Loro CRDT bridge. Creates typed entities and structured-concurrency clients.

```bash
pylon codegen --target swift
```

--------------------------------

### Deploying Pylon to AWS ECS with Aurora

Source: https://www.pylonsync.com

Deploys the Pylon application to AWS using Terraform, configuring ECS, Aurora (Postgres), load balancing, secrets, and VPC.

```bash
$ terraform apply
```

--------------------------------

### Defining a PylonSync Schema with Behaviors and Policies

Source: https://www.pylonsync.com

This TypeScript code defines an 'Order' entity schema using PylonSync's SDK. It includes composite indexes, row-level policies for read/update access, and attaches common behaviors like timestamps, soft deletes, and auditing.

```typescript
import { e, field, policy, timestamps, softDelete, audit } from "@pylonsync/sdk";

export const Order = e.entity("Order", {
  customer:  field.id("Customer"),
  total:     field.int(),                 cents
  status:    field.enum(["pending","paid","failed"]),
  createdAt: field.datetime().defaultNow(),
})
  .indexes(e.idx("customer", "createdAt"), e.idx("status"))
  .policies(policy({
    allowRead:   "auth.userId == data.customer || auth.hasRole('admin')",
    allowUpdate: "auth.hasRole('admin')",
  }))
  .behaviors([timestamps, softDelete, audit]);
// → pylon codegen client · OpenAPI at /api/openapi
```
Tokens:
Raw