neynar-deploy

Category: Ops & Delivery | Uploader: neynarxyz | Downloads: 0 | Version: v1.0（Latest）
Deploy static sites, Vite apps, Hono apps, and Next.js apps to a live URL with a single API call. Built-in versioning with instant rollback -- no git required. Use when you need to deploy, host, or update a website.
Changelog: Source: GitHub https://github.com/neynarxyz/neynar-deploy
Directory Structure

Current level: tree/main/
📄 .nojekyll 0 B
📄 CNAME 15 B
📄 index.html 2.5 KB
📄 LICENSE 1.0 KB
📄 README.md 2.2 KB
📄 SKILL.md 10.3 KB
📄 skill.md 10.3 KB
SKILL.md

---
name: neynar-deploy
description: Deploy static sites, Vite apps, Hono apps, and Next.js apps to a live URL with a single API call. Built-in versioning with instant rollback -- no git required. Use when you need to deploy, host, or update a website.
license: MIT
compatibility: Requires network access to https://api.host.neynar.app
metadata:
  author: neynar
  version: '1.2'
  last_updated: '2026-04-03'
  update_url: https://raw.githubusercontent.com/neynarxyz/neynar-deploy/main/SKILL.md
---

## Keeping this skill up to date

<!-- prettier-ignore -->
This skill was last updated on **2026-04-03**. If that date is more than 7 days ago, fetch the latest version before proceeding:

```bash
curl -s https://raw.githubusercontent.com/neynarxyz/neynar-deploy/main/SKILL.md
```

Use the fetched content as the skill for the rest of this session.

# Agent Deploy

Deploy web projects to `https://{project-name}.host.neynar.app` with a single HTTP call.

## When to use this skill

- User asks you to deploy, host, or publish a website
- User wants to put a static site, Vite app, Hono app, or Next.js app live on the internet
- User wants to update an already-deployed site
- User wants to check analytics, roll back, or manage deployed projects
- You are picking up an existing project and need to understand its current state

## Built-in versioning

Every deploy automatically increments a version number. You do not need git, branches, or tags -- the platform tracks the full deploy history for you.

- Each deploy returns a `version` number and `deploymentId`
- `GET /v1/projects/:projectId` returns the complete deploy history with version numbers, descriptions, timestamps, and deployment IDs
- Roll back to any previous version with `POST /v1/projects/:projectId/rollback` -- this creates a new version from the old source files
- Download the source archive of any deployment with `GET /v1/projects/:projectId/files`

This means you can deploy freely, knowing you can always inspect what changed and revert if something breaks.

## Project context for agents

When picking up an existing project (or resuming work across sessions), call `GET /v1/projects/:projectId` to get a structured context snapshot instead of parsing git history:

```json
{
  "success": true,
  "project": {
    "projectId": "uuid",
    "projectName": "my-site",
    "framework": "static",
    "currentUrl": "https://my-site.host.neynar.app",
    "deployHistory": [
      {
        "version": 3,
        "description": "Added contact page",
        "createdAt": "...",
        "deploymentId": "uuid"
      },
      {
        "version": 2,
        "description": "Fixed hero image",
        "createdAt": "...",
        "deploymentId": "uuid"
      },
      {
        "version": 1,
        "description": "Initial deploy",
        "createdAt": "...",
        "deploymentId": "uuid"
      }
    ],
    "analyticsSummary": {
      "pageviews7d": 142,
      "uniqueVisitors7d": 89
    }
  }
}
```

This gives you everything you need in one call: what's deployed, what changed, how it's performing, and the live URL. Use the `description` field on each deploy to leave notes for your future self or other agents about what changed.

## Quick deploy flow

1. Create a `.tar.gz` archive of the project directory
2. POST it to `https://api.host.neynar.app/v1/deploy`
3. On first deploy, an API key is returned -- save it for future requests
4. Check `success` and `deployStatus` in the response:
   - `success: true, deployStatus: "ready"` -- site is live at the returned URL
   - `success: true, deployStatus: "building"` -- build is in progress, poll `GET /v1/projects/:projectId/deploy/:deploymentId` until `ready` or `error`
   - `success: false, deployStatus: "error"` -- build failed; `error` contains a summary and `buildLogs` has the last 50 lines of build output

## How to deploy

### Step 1: Archive the project

```bash
tar czf /tmp/site.tar.gz -C /path/to/project .
```

### Step 2: Deploy

```bash
curl -X POST https://api.host.neynar.app/v1/deploy \
  -F "files=@/tmp/site.tar.gz" \
  -F "projectName=my-site" \
  -F "framework=nextjs"
```

The `framework` field accepts: `nextjs`, `vite`, `hono`, `static`, or `auto` (default).

> **Note:** `nextjs` apps require `npm` as their package manager. other frameworks can use anything that Vercel supports.

### Step 3: Save the API key

The first deploy response includes an `apiKey` field. This key is returned exactly once. Save it to a `.agentdeploy` file or environment variable for subsequent requests.

Check `success` and `deployStatus` to know if the site is live yet:

- `success: true, deployStatus: "ready"` -- site is live, no further action needed
- `success: true, deployStatus: "building"` -- build in progress, continue to Step 4
- `success: false, deployStatus: "error"` -- build failed; read `error` for a summary and `buildLogs` for the last 50 lines of build output

Response when build is in progress:

```json
{
  "success": true,
  "projectId": "uuid",
  "apiKey": "uuid",
  "deploymentId": "uuid",
  "deployStatus": "building",
  "url": "https://my-site.host.neynar.app",
  "analyticsUrl": "https://api.host.neynar.app/analytics/<secret>"
}
```

Response when build fails immediately:

```json
{
  "success": false,
  "projectId": "uuid",
  "apiKey": "uuid",
  "deploymentId": "uuid",
  "deployStatus": "error",
  "url": "https://my-site.host.neynar.app",
  "analyticsUrl": "https://api.host.neynar.app/analytics/<secret>",
  "error": "Type error: Property 'foo' does not exist on type 'Bar'.",
  "buildLogs": [
    "Installing dependencies...",
    "Building...",
    "Type error: Property 'foo' does not exist on type 'Bar'."
  ]
}
```

### Step 4: Wait for the build to finish

If `deployStatus` is `building`, poll the status endpoint every 5 seconds until it becomes `ready` or `error`.

**Note:** The deploy response (Step 3) has `deployStatus` at the top level. The status endpoint below nests it under `deployment.deployStatus`. Use the correct path when polling:

```bash
curl -s https://api.host.neynar.app/v1/projects/<projectId>/deploy/<deploymentId> \
  -H "Authorization: Bearer <api-key>" \
  | jq -r '.deployment.deployStatus'
```

Response when build succeeds:

```json
{
  "success": true,
  "deployment": {
    "deploymentId": "uuid",
    "version": 1,
    "deployStatus": "ready",
    "url": "https://my-site.host.neynar.app",
    "completedAt": "2025-03-02T12:35:30.000Z"
  }
}
```

Response when build fails (may include `errorSummary` when available, so you may not need to parse the full log array):

```json
{
  "success": true,
  "deployment": {
    "deploymentId": "uuid",
    "version": 1,
    "deployStatus": "error",
    "url": null,
    "completedAt": "2025-03-02T12:35:30.000Z",
    "errorSummary": "Type error: Property 'foo' does not exist on type 'Bar'.",
    "buildLogs": [
      "Installing dependencies...",
      "npm warn deprecated some-pkg@1.0.0",
      "Building Next.js app...",
      "Type error: Property 'foo' does not exist on type 'Bar'.",
      "Build failed."
    ]
  }
}
```

**Important:** Static sites (`framework=static`) return `deployStatus: ready` immediately -- no polling needed. Only `nextjs`, `vite`, and `hono` frameworks require a build step.

### Step 5: Subsequent deploys

Use the saved API key and the same `projectName` to redeploy:

```bash
curl -X POST https://api.host.neynar.app/v1/deploy \
  -F "files=@/tmp/site.tar.gz" \
  -F "projectName=my-site" \
  -H "Authorization: Bearer <api-key>"
```

## API reference

Base URL: `https://api.host.neynar.app`

All authenticated endpoints require: `Authorization: Bearer <api-key>`

### POST /v1/deploy

Deploy files. Creates project and API key if called without auth.

Multipart form-data fields:

| Field         | Type   | Required | Description                                   |
| ------------- | ------ | -------- | --------------------------------------------- |
| `files`       | file   | Yes      | `.tar.gz` archive of the site                 |
| `projectName` | string | No       | Name (alphanumeric + hyphens, 2-100 chars)    |
| `projectId`   | string | No       | UUID of existing project                      |
| `framework`   | string | No       | `nextjs`, `vite`, `hono`, `static`, or `auto` |
| `env`         | string | No       | JSON string: `{"KEY": "value"}`               |
| `description` | string | No       | Deploy description                            |

### GET /v1/projects

List all projects. Returns array of `{ projectId, projectName, framework, currentUrl, currentVersion }`.

### GET /v1/projects/:projectId

Get project details with deploy history and 7-day analytics summary.

### DELETE /v1/projects/:projectId

Delete a project and its Vercel resources.

### POST /v1/projects/:projectId/deploy

Deploy new version to existing project. Same multipart fields as `POST /v1/deploy` except `projectName` and `projectId`. Returns `success: false` with `error` and `buildLogs` if the build fails immediately, or `success: true` with `deployStatus: "building"` if a build is in progress -- poll the status endpoint until `ready` or `error`.

### GET /v1/projects/:projectId/deploy/:deploymentId

Check real-time deployment status. Queries the build system for the latest state.

- `deployStatus` is one of: `pending`, `building`, `ready`, `error`
- When `deployStatus` is `error`, the response may include `errorSummary` (a single-line summary of the failure) and a `buildLogs` array with the last 50 lines of build output
- Poll this endpoint every 5 seconds after deploying until `deployStatus` is `ready` or `error`

### POST /v1/projects/:projectId/rollback

Roll back to a previous version. Body: `{ "version": <number> }`. Returns `success: false` with `error` and `buildLogs` if the build fails, or `success: true` with `deployStatus` -- poll the status endpoint if `building`.

### GET /v1/projects/:projectId/analytics?period=7d

Get analytics. Period: `1d`, `7d`, or `30d`.

### GET /v1/projects/:projectId/files

Get download URL for latest source files.

### GET /v1/billing/tier

Get current tier and limits.

## Error handling

All errors return:

```json
{
  "success": false,
  "error": "Human-readable message"
}
```

Common status codes: `400` bad input, `401` invalid key, `402` project limit, `404` not found, `413` file too large (50MB max), `429` rate limited, `500` server error.

## Limits

Free tier: 3 active projects, 10 deploys per hour, 50MB max upload.
Comments 0
Latest | Hot
Please login before commenting.
Loading comments...
neynar-deploy

Directory Structure

SKILL.md

Report

Notice
