For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /get-started/web-test-chatgpt.md.
  • English
  • Get started: Web · Midscene Test · ChatGPT subscription

    These are the setup steps for Midscene on Web with Midscene Test and a ChatGPT subscription. To choose another combination, change the answers below or see all setup paths.

    Which platform do you want to automate?
    What do you want to do first?
    How will you connect a model?

    Step 1

    Install Node.js

    Install Node.js ^20.19.0 || ^22.12.0 || >=24.0.0, then check that node -v works in your terminal.

    The commands below use pnpm. If it is not installed yet, run npm install -g pnpm.

    Step 2

    Create a test project

    pnpm dlx @midscene/test create my-tests \
      --platform web \
      --package-manager pnpm
    cd my-tests

    The command generates the project files, installs dependencies, and generates the Node Spec. It does not run tests. For the generated files, see Project structure.

    Step 3

    Sign in with your ChatGPT subscription

    First, run the following command in your terminal:

    pnpm dlx @midscene/cli model siwc login

    Follow the terminal instructions to sign in to ChatGPT in your browser and authorize plan usage. You can choose a name for your Agent during authorization. Once authorized, the Agent appears on your ChatGPT usage page.

    The command saves credentials to ~/.midscene/siwc.json. Complete this sign-in manually before first use.

    Then, in the my-tests directory, copy .env.example to .env:

    cp .env.example .env

    Leave MIDSCENE_MODEL_BASE_URL and MIDSCENE_MODEL_API_KEY empty. Set MIDSCENE_MODEL_NAME and MIDSCENE_MODEL_FAMILY, and add MIDSCENE_MODEL_AUTH_MODE:

    MIDSCENE_MODEL_AUTH_MODE="siwc"
    MIDSCENE_MODEL_NAME="gpt-6-sol"
    MIDSCENE_MODEL_FAMILY="gpt-6"

    Available models depend on your ChatGPT account. For credentials and usage, see Use a ChatGPT subscription.

    Step 4

    Verify the model and finish setup

    Verify model connectivity and Midscene compatibility. The command reads .env from the current directory and does not need a browser or device:

    pnpm exec midscene-test model verify

    If the check fails, see Verify model connectivity.

    Install Chromium for Playwright:

    pnpm exec playwright install chromium

    Step 5

    Run the example and inspect the report

    The example opens React TodoMVC in Chromium, seeds three todos, and changes them with aiAct and aiAssert.

    pnpm test

    The terminal prints the results and a Report: path. Open the HTML report, then select a case and a step to inspect screenshots, inputs, outputs, and errors. Reports are written to midscene_run/report/ by default.

    When the case passes, your model, environment, and project are all working. For execution options, see Run tests.

    Step 6

    Next steps

    • Explore more examples: Showcases includes demo videos and full execution reports across platforms.
    • Test your own site: In cases/todo.yaml, replace the TodoMVC setup in beforeEach with a gotoUrl Node for your URL, then describe the steps with aiAct and aiAssert. See Built-in Nodes across platforms.

    Want to try another platform or way to use Midscene? Back to top to change your selections.