# servix — knowledge index

Package: `@x12i/servix-docs`

## How to choose

- **Concept** — what it is and why it exists
- **Guide** — bounded task procedure
- **Scenario** — state + evidence → which path
- **Use case** — end-to-end outcome
- **Tutorial** — learn by doing
- **Decision** — options and recommended default
- **Reference / API** — exact technical detail

## Manifest and search

- `agent-manifest.json`
- `SEARCH.json`

## Concepts

- `listener-vs-proactive` — **Listener vs proactive workers** — Listener workers wait for external events and are fully implemented; proactive workers run on schedules and are typed but not executed yet in v0.1. — [concepts/listener-vs-proactive.md](concepts/listener-vs-proactive.md)
- `pause-vs-stop` — **Pause vs stop** — Pause suspends work while the process keeps running; stop exits the process entirely. — [concepts/pause-vs-stop.md](concepts/pause-vs-stop.md)
- `service-discovery` — **Service discovery via package.json** — Servix finds a service entry through the servix.entry field in package.json, so any compatible npm package is installable by name. — [concepts/service-discovery.md](concepts/service-discovery.md)
- `service-shell` — **The service shell** — Servix is the lifecycle shell around your logic — it supervises, schedules, logs, and persists, but never becomes the business logic. — [concepts/service-shell.md](concepts/service-shell.md)
- `wrap-once-run-managed` — **Wrap once, run managed** — You wrap existing logic exactly once with defineServixService; from then on it behaves like an installable, controllable service. — [concepts/wrap-once-run-managed.md](concepts/wrap-once-run-managed.md)

## Guides

- `install-and-run` — **Install and run a service** — Install the servix CLI, install a service by package name or path, and drive it through its lifecycle. — [guides/install-and-run.md](guides/install-and-run.md)
- `wrap-a-cli-command` — **Wrap a CLI command** — Run an existing CLI command as a supervised recurring job using ctx.exec, without rewriting its logic. — [guides/wrap-a-cli-command.md](guides/wrap-a-cli-command.md)
- `wrap-a-function` — **Wrap an existing function** — Turn a TypeScript function into a scheduled managed service with one defineServixService call. — [guides/wrap-a-function.md](guides/wrap-a-function.md)
- `wrap-a-listener` — **Wrap a webhook listener** — Keep an HTTP webhook handler alive as a managed listener worker with routes on the managed HTTP context. — [guides/wrap-a-listener.md](guides/wrap-a-listener.md)

## Scenarios

- `choose-worker-type` — **Choose the right worker type** — Decide between a listener worker and a proactive worker for the logic you are wrapping. — [scenarios/choose-worker-type.md](scenarios/choose-worker-type.md)

## Diagrams

_None authored yet._

## Tutorials

_None authored yet._