# Nuime

> Nuime (NUI: Non Visual Use with Intelligence) is a toolkit that works with the NVDA screen
> reader. It lets AI agents operate Windows applications by relying on what NVDA speaks —
> focus, button names, dialog texts — instead of pixels. Automation uses plain-text NUI
> programs that are Git-versionable, with speech-log evidence recorded for every run.
> Commercial software by Shuaruta Inc. The Desktop alpha (free for non-commercial personal
> use) is distributed for Windows 10/11.

Nuime is for screen reader users, web creators verifying accessibility (WCAG/WAIC as_test
scenarios), and AI agents that need to drive Windows GUIs accessibly.

## Products

- [Nuime Desktop](https://www.nuime.net/): Windows RDA runtime. Embedded NVDA relay, `.nui`
  program runner, MAF agent, WCAG test automation. Configurable LLM backends:
  LM Studio, Ollama (local / Cloud), OpenAI, Anthropic, Microsoft Foundry Local, or any
  generic OpenAI-compatible server. Alpha distributed via App Installer.
- [Nuime Desktop (English)](https://www.nuime.net/en/): English landing page.
- Nuime Cloud (in development): enterprise-ready NVDA remote connection. Not yet public.
- Nuime Mobile (planned): mobile app to operate Nuime Desktop.

## Getting started

- [Download the alpha](https://www.nuime.net/): landing page with terms acceptance (Japanese).
- [Alpha terms of use](https://www.nuime.net/ja/desktop-alpha.html): Japanese-only terms page.

## CLI reference (recommended entry point for AI agents)

- [nuime CLI reference (English)](https://www.nuime.net/en/cli-reference.html): validate and
  run NUI programs from the command line; headless Desktop lifecycle (`serve`/`stop`/`status`);
  exit codes 0/1/2/3; `--json` machine-readable output; MCP connection details.
- [nuime CLI reference (Japanese)](https://www.nuime.net/ja/cli-reference.html): same content
  in Japanese, the primary localized version.

Key facts for agents:

- The CLI (`nuime.exe`, shipped inside the desktop MSIX) wraps the same tools as
  nuime-desktop-mcp at `http://127.0.0.1:3002/mcp`.
- `mcp.http.toolSubset: all` in the project's `nuiproject.yaml` is required for
  `run_program` (program execution) and modifying files (`edit_project_file`, `fork_bundled_program`); read-only tools (`validate_program`, `list_runs`, `get_run_log`, `list_programs`, `list_skills`, `search_skills`, `read_project_file`, `search_project_files`) are available in the default subset.
  Settings can be reloaded without restarting Desktop via `nuime reload` or the `reload_project` MCP tool.
- NVDA must be connected to the Desktop's embedded relay (port 6837) before NUI runs.
  Install via `winget install -e --id NVAccess.NVDA`, manage the process via `nuime nvda start / stop / restart / status`,
  auto-configure startup connection via `nuime nvda config` (or `--write-config`), and wait for relay connection via `nuime nvda wait`. Run `nuime nvda` for the full guide.
- Secret values are only accepted via stdin pipe or masked prompt — never CLI arguments.
- WSL (Windows Subsystem for Linux): `/mnt/c/...` paths are automatically converted to Windows paths (`C:\...`). Projects must be placed under a Windows drive.
- CLI output size control: `nuime log` truncates to 200 lines / 12,000 characters by default to protect context windows (use `--full`, `--summary`, or `--tail <N>`). `nuime runs --brief` provides compact one-line summaries.

## Documentation for AI agents

- [nuime CLI reference (English)](https://www.nuime.net/en/cli-reference.html):
  full CLI reference with examples, exit codes, and an L1 command overview.
- [nuime CLI reference (Japanese)](https://www.nuime.net/ja/cli-reference.html):
  same content in Japanese, the primary localized version.
- [llms-full.txt](https://www.nuime.net/llms-full.txt): this CLI reference as
  plain text (no HTML parsing needed).

Design documents are maintained in the vendor's internal repository and are
available on request via the contact form.

## Contact

- [Inquiry form](https://forms.office.com/r/s1H0hm3aeX) or info@shuaruta.com
- Operated by [Shuaruta Inc.](https://www.shuaruta.com/)