DocsOverview

Get started

Wireface documentation

How to install Wireface, use everything it does, change every setting, and build its talking face into your own pages.

On this page
  1. What Wireface is
  2. Start here
  3. All the pages
  4. Licence

What Wireface is

Wireface gives an AI agent a face and a voice. It comes in three parts:

  • Wireface Desktop is a Windows app. A lip-synced 3D face floats over your windows, in front of the agent you already use: Claude Code, OpenCode or Codex. You talk to it, the agent does the work in the background, and a realtime voice tells you how it's going. It can also share a room with other faces, use your PC, and answer a phone line.
  • wireface-core is the face engine on its own, for the browser: plain ES modules on WebGL2, with no build step and no dependencies. It has skins, expressions, teeth, and lip sync from recorded clips or live audio. It's the same engine Wireface Desktop runs.
  • wireface.dev is this website. You can try the face in your browser, talk with it, and copy the code to embed it in any page.

Wireface doesn't ship an agent of its own. It drives the harness you've already set up, with your sign-in, model, skills, MCP servers and instructions, and passes your words to it exactly as you said them. Its Tools tab shows the agent's MCP servers and skills, and switches them on and off in the agent's own configuration.

Start here

All the pages

Get started

  • Install: requirements, the installer, the first start, connecting an agent, API keys, several faces, running from source, updating and uninstalling, and installing wireface-core.
  • Features: what everything does, with links to the details.

Wireface Desktop

  • Using the app: the face, its right-click menu and tray icon, and the panel tab by tab.
  • Voice and hearing: listening, saying its name to cut in, the realtime voice and the classic voice.
  • Agents and permissions: choosing the agent and its model and folder, when it asks first, and letting it use your PC.
  • MCP servers and skills: the agent's MCP servers and skills, switching them on and off, and installing recommended ones.
  • Rooms: several faces with different agents sharing one microphone.
  • Phone line: a Twilio number with a receptionist, and your agent's texts and calls.

Reference

  • Configuration: every face setting with its default and range, each desktop face's files and profile.json, environment variables and the command line.

Developers

  • wireface-core: the developer guide and API reference for the face engine.
  • Embedding: the iframe, its URL parameters and its messages.

Help

Licence

Wireface Desktop and wireface-core are free for personal and non-commercial use, under the PolyForm Noncommercial License 1.0.0. Using them at work, for clients, or in a product or service you sell needs a commercial licence: £1,000 once, covering both, with the full source code and no limits on users, devices or projects. See licence and pricing.