With your coding agent

This is the developer path. You work in your own editor, your own repo, with your own coding assistant. Notis gives the agent one path to create, preview, and deploy the app.

Prerequisites

The Notis desktop app, installed and signed in. It keeps the Notis CLI authenticated.
A local code agent (ChatGPT desktop, Claude Code, Cursor, OpenClaw, Hermes, OpenCode, or just a terminal).
Node.js 18+.

The desktop app also syncs the built-in notis-cli and notis-apps skills, so local agents can discover the CLI workflow and the app platform rules without extra setup. Verify the CLI is ready:

npx --package @notis_ai/cli@latest -- notis doctor

If the doctor check passes, you’re set. If not, open the Notis desktop app and sign in.

Start the wizard (or skip it)

The fastest way to start is from the portal:

Open the Notis portal and click + Create app.
Pick a name and an optional starting point (empty scaffold, or Databases, 5 Minutes Journal, Notis Notes, or Random Number Generator).
Choose your local code agent as the builder.
Click Get the prompt — Notis generates a copy-paste prompt tuned to your starting point. Paste it into your coding agent and let it drive the CLI for you.

You can also skip the wizard entirely and drive the CLI by hand.

Manual workflow

1. Scaffold a new app

npx --package @notis_ai/cli@latest -- notis apps scaffolds list
npx --package @notis_ai/cli@latest -- notis apps init "My Task Manager" --from notis-database
cd "my-task-manager"

This creates a Vite + React project with:

notis.config.ts — the app declaration (metadata, databases, routes, tools).
CHANGELOG.md — the release history shown on App Details and in the Store.
app/ — your React pages.
components/ — scaffolded shadcn UI components.
vite.config.ts — wrapped with notisViteConfig().
Tailwind and @notis/sdk pre-configured.

2. Configure the app

Edit notis.config.ts:

import { defineNotisApp } from '@notis/sdk/config';

export default defineNotisApp({
  name: 'task-manager',
  title: 'Task Manager',
  description: 'Track and manage team tasks',
  icon: 'phosphor:check-square',
  categories: ['Productivity'],
  tagline: 'Plan, assign, and ship team tasks.',
  screenshots: [
    { path: 'metadata/screenshot-1.png', alt: 'Task dashboard with priorities and owners.', route: 'dashboard' },
    { path: 'metadata/screenshot-2.png', alt: 'All tasks grouped by status.', route: 'tasks' },
    { path: 'metadata/screenshot-3.png', alt: 'A task detail view with its activity.', route: 'tasks' },
  ],

  databases: ['tasks'],

  routes: [
    { path: '/', slug: 'dashboard', name: 'Dashboard', icon: 'phosphor:squares-four', default: true },
    {
      path: '/tasks', slug: 'tasks', name: 'All Tasks', icon: 'phosphor:list',
      collection: { database: 'tasks', titleProperty: 'title' },
    },
  ],

  tools: ['LOCAL_NOTIS_DATABASE_QUERY'],
});

Also add a release version to package.json:

{
  "notisAppVersion": "0.1.0"
}

Keep release copy in CHANGELOG.md, newest first:

## [Initial Release] - {PR_MERGE_DATE}

- Added the first task dashboard and task list.

3. Build your pages

Pages live under app/. Use the SDK hooks instead of calling the Notis backend yourself. For database-backed apps, useDocuments, useDocument, useDatabaseSchema, and DocumentEditor cover the common list, detail, schema, and editing flows. Markdown renders saved document content with the same styles as the Portal.

'use client';
import { useDocuments } from '@notis/sdk';
import { Card } from '@/components/ui/card';

export default function Dashboard() {
  const { documents, loading } = useDocuments('tasks', { pageSize: 25 });

  return (
    <div className="p-6 space-y-4">
      <h1 className="text-2xl font-bold">Dashboard</h1>
      {loading ? <p>Loading…</p> : null}
      {documents.map(document => (
        <Card key={document.id} className="p-4">{document.title}</Card>
      ))}
    </div>
  );
}

4. Develop locally

npx --package @notis_ai/cli@latest -- notis apps dev

This opens the Notis desktop app directly to your local app when possible, and every active local app appears in the Local development sidebar group. Edits hot-reload. When the app is visible in Local development, the CLI reports it as mounted. If Notis was closed when you started, open the desktop app; the development session keeps waiting and connects when Notis is ready.

5. Build, capture, verify, and deploy

npx --package @notis_ai/cli@latest -- notis apps build
npx --package @notis_ai/cli@latest -- notis apps screenshot
npx --package @notis_ai/cli@latest -- notis apps verify
npx --package @notis_ai/cli@latest -- notis apps create "Task Manager" .
npx --package @notis_ai/cli@latest -- notis apps deploy

Screenshot declarations decide which route, sample scenario, focus area, and light or dark theme to capture. The command creates the Store-ready images for you. Use --mode live when the listing should show your real signed-in data rather than sample data, and review the images before publishing. Or, if the remote app already exists:

npx --package @notis_ai/cli@latest -- notis apps link <app-id>
npx --package @notis_ai/cli@latest -- notis apps deploy

6. Diagnose a project

npx --package @notis_ai/cli@latest -- notis apps doctor

Reports anything the platform expects but didn’t find — missing routes, broken config, unknown tools, incomplete Store details, missing release history, or invalid screenshots.

Forking an existing app

You can start from an app you already have installed:

npx --package @notis_ai/cli@latest -- notis apps pull <app-id> ./<dir>
cd ./<dir>
npm install
npx --package @notis_ai/cli@latest -- notis apps dev
# edit, then build the saved source snapshot
npx --package @notis_ai/cli@latest -- notis apps build
npx --package @notis_ai/cli@latest -- notis apps create "My Fork" .
npx --package @notis_ai/cli@latest -- notis apps deploy

Forked apps live as separate listings — existing installs of the original keep their upstream link. Apps deployed with older tooling may not have a saved source snapshot yet. Redeploy them once with the current CLI before pulling.

Publishing

When the app is ready, review App Details (/apps/[appId]) and its Store checklist. Publish there, or explicitly approve the preview and let your coding agent submit the exact deployed version:

npx --package @notis_ai/cli@latest -- notis apps publish --confirm-ready

Deploy and Store publication are separate. Deploy updates your installed app. Publish shares that deployed version with your team or sends it for public review. Store details live in notis.config.ts, metadata/, CHANGELOG.md, and package.json, so the preview always comes from reviewable source files.

Sync Integrations — let local agents use your Notis integrations.
Overview — what apps are.
With Notis — the chat path.
Publish — ship to team or public.

Get Started

Customize

Channels

Core capabilities

Your Computer

Notis CLI/MCP

Agent routing

Apps

Account & Settings

Prerequisites

Start the wizard (or skip it)

Manual workflow

1. Scaffold a new app

2. Configure the app

3. Build your pages

4. Develop locally

5. Build, capture, verify, and deploy

6. Diagnose a project

Forking an existing app

Publishing

​Prerequisites

​Start the wizard (or skip it)

​Manual workflow

​1. Scaffold a new app

​2. Configure the app

​3. Build your pages

​4. Develop locally

​5. Build, capture, verify, and deploy

​6. Diagnose a project

​Forking an existing app

​Publishing

​Related

Prerequisites

Start the wizard (or skip it)

Manual workflow

1. Scaffold a new app

2. Configure the app

3. Build your pages

4. Develop locally

5. Build, capture, verify, and deploy

6. Diagnose a project

Forking an existing app

Publishing

Related