> For the complete documentation index, see [llms.txt](https://yvechat.gitbook.io/wp/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://yvechat.gitbook.io/wp/getting-started/install-engine.md).
# Install YveChat Engine
YveChat Engine runs on your computer and does the work the browser cannot do.
{% hint style="warning" %}
**This build is not signed.** Signing, notarization, and automatic updates are planned and have no release artifacts yet. Until those exist, your operating system will warn you before the Engine runs, so verify the published checksum before trusting a download. Every download origin is listed on [Verified Links](/wp/resources/verified-links.md).
{% endhint %}
The hosted workspace reports no local connection until the local component is running and paired
***
### What YveChat Engine does
| Responsibility | Detail |
| -------------------- | ----------------------------------------------- |
| Runtime discovery | Finds installed runtimes and lists their models |
| Request execution | Runs model requests on your machine |
| Conversation storage | Stores conversations locally |
| Local authentication | Manages local sign-in |
| Origin policy | Decides which web origins may connect |
It listens on a loopback address, which means the address is reachable from your own computer alone.
***
### Current installation path
YveChat Engine is downloaded as one archive covering Windows, macOS, and Linux, and started with the launcher for your system. That path suits developers and operators comfortable with a terminal.
Requirements:
* [Node.js 24 or newer](https://nodejs.org/), which the launcher checks before starting
* An internet connection on first launch, which installs the locked dependencies
* Ollama already installed, covered in [Install Ollama](/wp/getting-started/install-ollama.md)
Download from [github.com/YveLabs/yvechat-engine/releases](https://github.com/YveLabs/yvechat-engine/releases), the origin listed on [Verified Links](/wp/resources/verified-links.md). Compare the published SHA-256 checksum against your download, extract it to a permanent folder, then run `start-windows.ps1`, `start-macos.command`, or `start-linux.sh`. Keep that window open, as closing it stops the Engine. The archive also contains the Engine's full source.
***
### Confirm it is running
YveChat Engine reports its loopback address on startup. Opening that address in a browser shows the local approval interface, which is the same page used during [Pair Your Browser](/wp/getting-started/pair-your-browser.md).
Seeing that page confirms three things at once: YveChat Engine is running, it is reachable on loopback, and your browser can talk to it.
***
### Local access and hosted access
Two ways to reach the workspace exist, and they authenticate differently.
| Access | Address | Authentication |
| ------ | --------------------------- | ------------------------------------------------------------ |
| Local | The Engine loopback address | A secure local session cookie, set after you sign in locally |
| Hosted | `app.yvechat.xyz` | A paired token, bound to the approved origin |
Local access works without pairing because the page and the service share an origin. Hosted access requires the pairing step.
***
### Sign in
YveChat Engine manages profiles on your machine. Two methods are supported.
**Local accounts.** A profile held locally, opened with credentials you set.
**Wallet authentication.** Optional. Signing with a wallet creates a local profile, or identifies an existing one. The signature identifies the profile held by YveChat Engine on your machine.
Choose whichever suits you. Wallet authentication remains optional at every step.
***
### What is planned
| Item | Status |
| ----------------------------------------------- | --------- |
| Published checksums | Available |
| Signed installers for Windows, macOS, and Linux | Planned |
| Notarization | Planned |
| Automatic updates | Planned |
These appear in the [release readiness checklist](/wp/resources/release-readiness.md) and carry no date.
***
### Next
Continue to [Install Ollama](/wp/getting-started/install-ollama.md).
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://yvechat.gitbook.io/wp/getting-started/install-engine.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.