Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.simular.ai/llms.txt

Use this file to discover all available pages before exploring further.

Using Simulang with Claude Code

Simulang is a Claude Code skill for desktop automation on macOS. You describe the task in natural language (open apps, click controls, type text, scroll, capture screenshots, inspect the accessibility tree); Claude looks up the installed simulib-js API, writes a TypeScript script, and runs it with the Simulang CLI—same building blocks as the Simulang Primer.

Setup

  1. Install simulang CLI globally:
    npm install -g @simular-ai/simulang
    
  2. Install the Claude Code skill:
    simulang init-claude
    
  3. (Optional) Enable the log viewer for visual debugging:
    npm install @simular-ai/simulib-log-viewer
    
    Then tell Claude: /simulang enable log view in all scripts

Usage

Invoke the skill with /simulang followed by what you want to do:
/simulang open google and search for weather in sf
/simulang take a screenshot of the current screen
/simulang find all buttons on the screen using accessibility tree
/simulang click on the submit button
/simulang type "hello world" and press enter
Claude will:
  1. Look up the simulib-js API docs for the installed version
  2. Write a TypeScript script
  3. Run it with simulang run
  4. Show you screenshots or results

Example Prompts

PromptWhat Claude Does
/simulang open safari and go to github.comOpens browser, navigates to URL
/simulang search for "Simular" on this pagePresses Cmd+F, types search term
/simulang scroll down and take a screenshotScrolls, captures screen
/simulang what's the version of simulang?Runs simulang --version
/simulang read the simulib-js API docsReads index.d.ts and CLAUDE.md

Tips

  • Be specific — “click the blue Submit button” works better than “click submit”
  • Ask for screenshots — Claude can capture and view what’s on screen
  • Use grounding models — For visual element finding, set OPENROUTER_API_KEY
  • Enable log viewer — Helps when the terminal is hidden behind automated apps

Requirements

  • Node.js >= 22.18
  • macOS: Grant Accessibility and Screen Recording permissions when prompted