Skip to content

Quickstart

Go from an empty folder to an application running in the local emulator. Let a coding agent write it, or create it yourself.

You need Node.js 24 or newer. For the emulator, you also need Docker and mkcert.

  1. Install Adaptkit.

    Terminal window
    npm install --global @mochabug/adaptkit@latest
  2. Create a Git repository for your applications, and install the agent skills in it.

    Terminal window
    mkdir adapt-apps && cd adapt-apps
    git init
    adaptkit skill
  3. Create the application.

    Start your coding agent in the repository, and describe the application:

    Create an Adapt app in hello_world/. It has one vertex, "greeting".
    The vertex shows a page where a visitor types their name and clicks Send.
    Then it sends the name on its output and completes. In the vertex settings,
    users can change the page's heading.

    The agent proposes a structure first: the vertices, their signals, and their pages. Approve it, and the agent creates the project, writes the code, and builds it.

  4. Preview the pages.

    Terminal window
    cd hello_world
    npm run dev

    The server prints its address and a path for each page:

    ➜ Local: http://localhost:3000/
    → greeting/executor · /src/greeting/ui/executor.html

    Open http://localhost:3000/src/greeting/ui/executor.html. A mock API stands in for the backend.

  5. Run it in the emulator.

    Terminal window
    adaptkit emulator setup # once: trusts the emulator's certificates
    npm run emulator # starts the emulator at http://localhost:51001
    npm run emulate # builds and uploads the application

    In the emulator, select the greeting vertex. If it has a settings page, click Configure and save. Then click Run to use the page. See Test in the emulator.

  6. Publish it.

    Set organization in manifest.json to your organization’s ID, and replace the placeholder texts. Then:

    Terminal window
    adaptkit version patch
    npm run publish

    Adaptkit opens your browser to sign in, then uploads. See Publish and update.