> For the complete documentation index, see [llms.txt](https://faction-os.gitbook.io/faction-os-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://faction-os.gitbook.io/faction-os-docs/apps/readme_apps.md).

# Apps Directory

This directory contains the runnable FactionOS applications and integrations. Each package owns its own setup notes and current limitations. Use the package-specific README before changing a package.

| Package     | Purpose                                                                             | README                        |
| ----------- | ----------------------------------------------------------------------------------- | ----------------------------- |
| `adapters/` | Outbound Discord, Telegram, and generic webhook bridges.                            | `adapters/README_adapters.md` |
| `cli/`      | Local installer, status, doctor, and uninstall commands.                            | `cli/README_cli.md`           |
| `hooks/`    | Provider-neutral hook handlers, provider-specific source maps, and listener bridge. | `hooks/README_hooks.md`       |
| `server/`   | Local Express and WebSocket runtime.                                                | `server/README_server.md`     |
| `warroom/`  | Optional Cloudflare Worker and Durable Object relay backend.                        | `warroom/README_warroom.md`   |
| `web/`      | Vite React client and battlefield cockpit.                                          | `web/README_web.md`           |

Root `README.md` is reserved for the main project overview. Subdirectories use `README_<dirname>.md`.

For cross-package behavior, read the product PRD in `docs/PRD.md`, the UX PRD in `docs/PRD_UX.md`, and `../packages/protocol/README_protocol.md`, before duplicating contracts in app code.

## Phase 08 Release-Candidate Boundaries

Session 08 records passing local app and public-demo Playwright evidence in `.spec_system/archive/phases/phase_08/release_candidate_validation_record.md`. The app packages should keep that evidence scoped to local browser validation. It does not prove deployed app hosting, hosted identity, hosted storage, analytics, push, remote access, formal mobile/WCAG certification, real executors, broad media readiness, or full trusted unified erasure.

When changing e2e wiring, keep local server auth explicit, CORS and WebSocket origins narrow to the selected local app origins, and orchestration fixtures seeded through supported local routes such as `/event`, `/task-queue`, and `/guarded-actions`.


---

# 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://faction-os.gitbook.io/faction-os-docs/apps/readme_apps.md?ask=<question>&goal=<endgoal>
```

`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.