vilvona 1.0.0

package/docs/tools/elevated.md

@@ -0,0 +1,128 @@
+---
+summary: "Elevated exec mode: run commands outside the sandbox from a sandboxed agent"
+read_when:
+  - Adjusting elevated mode defaults, allowlists, or slash command behavior
+  - Understanding how sandboxed agents can access the host
+title: "Elevated mode"
+---
+
+When an agent runs inside a sandbox, its `exec` commands are confined to the
+sandbox environment. **Elevated mode** lets the agent break out and run commands
+outside the sandbox instead, with configurable approval gates.
+
+<Info>
+  Elevated mode only changes behavior when the agent is **sandboxed**. For
+  unsandboxed agents, exec already runs on the host.
+</Info>
+
+## Directives
+
+Control elevated mode per-session with slash commands:
+
+| Directive        | What it does                                                           |
+| ---------------- | ---------------------------------------------------------------------- |
+| `/elevated on`   | Run outside the sandbox on the configured host path, keep approvals    |
+| `/elevated ask`  | Same as `on` (alias)                                                   |
+| `/elevated full` | Run outside the sandbox on the configured host path and skip approvals |
+| `/elevated off`  | Return to sandbox-confined execution                                   |
+
+Also available as `/elev on|off|ask|full`.
+
+Send `/elevated` with no argument to see the current level.
+
+## How it works
+
+<Steps>
+  <Step title="Check availability">
+    Elevated must be enabled in config and the sender must be on the allowlist:
+
+    ```json5
+    {
+      tools: {
+        elevated: {
+          enabled: true,
+          allowFrom: {
+            discord: ["user-id-123"],
+            whatsapp: ["+15555550123"],
+          },
+        },
+      },
+    }
+    ```
+
+  </Step>
+
+  <Step title="Set the level">
+    Send a directive-only message to set the session default:
+
+    ```
+    /elevated full
+    ```
+
+    Or use it inline (applies to that message only):
+
+    ```
+    /elevated on run the deployment script
+    ```
+
+  </Step>
+
+  <Step title="Commands run outside the sandbox">
+    With elevated active, `exec` calls leave the sandbox. The effective host is
+    `gateway` by default, or `node` when the configured/session exec target is
+    `node`. In `full` mode, exec approvals are skipped. In `on`/`ask` mode,
+    configured approval rules still apply.
+  </Step>
+</Steps>
+
+## Resolution order
+
+1. **Inline directive** on the message (applies only to that message)
+2. **Session override** (set by sending a directive-only message)
+3. **Global default** (`agents.defaults.elevatedDefault` in config)
+
+## Availability and allowlists
+
+- **Global gate**: `tools.elevated.enabled` (must be `true`)
+- **Sender allowlist**: `tools.elevated.allowFrom` with per-channel lists
+- **Per-agent gate**: `agents.list[].tools.elevated.enabled` (can only further restrict)
+- **Per-agent allowlist**: `agents.list[].tools.elevated.allowFrom` (sender must match both global + per-agent)
+- **Discord fallback**: if `tools.elevated.allowFrom.discord` is omitted, `channels.discord.allowFrom` is used as fallback
+- **All gates must pass**; otherwise elevated is treated as unavailable
+
+Allowlist entry formats:
+
+| Prefix                  | Matches                         |
+| ----------------------- | ------------------------------- |
+| (none)                  | Sender ID, E.164, or From field |
+| `name:`                 | Sender display name             |
+| `username:`             | Sender username                 |
+| `tag:`                  | Sender tag                      |
+| `id:`, `from:`, `e164:` | Explicit identity targeting     |
+
+## What elevated does not control
+
+- **Tool policy**: if `exec` is denied by tool policy, elevated cannot override it.
+- **Host selection policy**: elevated does not turn `auto` into a free cross-host override. It uses the configured/session exec target rules, choosing `node` only when the target is already `node`.
+- **Separate from `/exec`**: the `/exec` directive adjusts per-session exec defaults for authorized senders and does not require elevated mode.
+
+<Note>
+  The bash chat command (`!` prefix; `/bash` alias) is a separate gate that requires `tools.elevated` to be enabled in addition to its own `tools.bash.enabled` flag. Disabling elevated locks `!` shell commands out as well.
+</Note>
+
+## Related
+
+<CardGroup cols={2}>
+  <Card title="Exec tool" href="/tools/exec" icon="terminal">
+    Shell command execution from the agent.
+  </Card>
+  <Card title="Exec approvals" href="/tools/exec-approvals" icon="shield">
+    Approval and allowlist system for `exec`.
+  </Card>
+  <Card title="Sandboxing" href="/gateway/sandboxing" icon="box">
+    Gateway-level sandbox configuration.
+  </Card>
+  <Card title="Sandbox vs Tool Policy vs Elevated" href="/gateway/sandbox-vs-tool-policy-vs-elevated" icon="scale-balanced">
+    How the three gates compose during a tool call.
+  </Card>
+</CardGroup>

package/docs/tools/exa-search.md

@@ -0,0 +1,152 @@
+---
+summary: "Exa AI search -- neural and keyword search with content extraction"
+read_when:
+  - You want to use Exa for web_search
+  - You need an EXA_API_KEY
+  - You want neural search or content extraction
+title: "Exa search"
+---
+
+OpenClaw supports [Exa AI](https://exa.ai/) as a `web_search` provider. Exa
+offers neural, keyword, and hybrid search modes with built-in content
+extraction (highlights, text, summaries).
+
+## Get an API key
+
+<Steps>
+  <Step title="Create an account">
+    Sign up at [exa.ai](https://exa.ai/) and generate an API key from your
+    dashboard.
+  </Step>
+  <Step title="Store the key">
+    Set `EXA_API_KEY` in the Gateway environment, or configure via:
+
+    ```bash
+    openclaw configure --section web
+    ```
+
+  </Step>
+</Steps>
+
+## Config
+
+```json5
+{
+  plugins: {
+    entries: {
+      exa: {
+        config: {
+          webSearch: {
+            apiKey: "exa-...", // optional if EXA_API_KEY is set
+            baseUrl: "https://api.exa.ai", // optional; OpenClaw appends /search
+          },
+        },
+      },
+    },
+  },
+  tools: {
+    web: {
+      search: {
+        provider: "exa",
+      },
+    },
+  },
+}
+```
+
+**Environment alternative:** set `EXA_API_KEY` in the Gateway environment.
+For a gateway install, put it in `~/.openclaw/.env`.
+
+## Base URL override
+
+Set `plugins.entries.exa.config.webSearch.baseUrl` when Exa search requests
+should go through a compatible proxy or alternate Exa endpoint. OpenClaw
+normalizes bare hosts by prepending `https://` and appends `/search` unless the
+path already ends there. The resolved endpoint is included in the search cache
+key, so results from different Exa endpoints are not shared.
+
+## Tool parameters
+
+<ParamField path="query" type="string" required>
+Search query.
+</ParamField>
+
+<ParamField path="count" type="number">
+Results to return (1–100).
+</ParamField>
+
+<ParamField path="type" type="'auto' | 'neural' | 'fast' | 'deep' | 'deep-reasoning' | 'instant'">
+Search mode.
+</ParamField>
+
+<ParamField path="freshness" type="'day' | 'week' | 'month' | 'year'">
+Time filter.
+</ParamField>
+
+<ParamField path="date_after" type="string">
+Results after this date (`YYYY-MM-DD`).
+</ParamField>
+
+<ParamField path="date_before" type="string">
+Results before this date (`YYYY-MM-DD`).
+</ParamField>
+
+<ParamField path="contents" type="object">
+Content extraction options (see below).
+</ParamField>
+
+### Content extraction
+
+Exa can return extracted content alongside search results. Pass a `contents`
+object to enable:
+
+```javascript
+await web_search({
+  query: "transformer architecture explained",
+  type: "neural",
+  contents: {
+    text: true, // full page text
+    highlights: { numSentences: 3 }, // key sentences
+    summary: true, // AI summary
+  },
+});
+```
+
+| Contents option | Type                                                                  | Description            |
+| --------------- | --------------------------------------------------------------------- | ---------------------- |
+| `text`          | `boolean \| { maxCharacters }`                                        | Extract full page text |
+| `highlights`    | `boolean \| { maxCharacters, query, numSentences, highlightsPerUrl }` | Extract key sentences  |
+| `summary`       | `boolean \| { query }`                                                | AI-generated summary   |
+
+### Search modes
+
+| Mode             | Description                       |
+| ---------------- | --------------------------------- |
+| `auto`           | Exa picks the best mode (default) |
+| `neural`         | Semantic/meaning-based search     |
+| `fast`           | Quick keyword search              |
+| `deep`           | Thorough deep search              |
+| `deep-reasoning` | Deep search with reasoning        |
+| `instant`        | Fastest results                   |
+
+## Notes
+
+- If no `contents` option is provided, Exa defaults to `{ highlights: true }`
+  so results include key sentence excerpts
+- Results preserve `highlightScores` and `summary` fields from the Exa API
+  response when available
+- Result descriptions are resolved from highlights first, then summary, then
+  full text — whichever is available
+- `freshness` and `date_after`/`date_before` cannot be combined — use one
+  time-filter mode
+- Up to 100 results can be returned per query (subject to Exa search-type
+  limits)
+- Results are cached for 15 minutes by default (configurable via
+  `cacheTtlMinutes`)
+- Exa is an official API integration with structured JSON responses
+
+## Related
+
+- [Web Search overview](/tools/web) -- all providers and auto-detection
+- [Brave Search](/tools/brave-search) -- structured results with country/language filters
+- [Perplexity Search](/tools/perplexity-search) -- structured results with domain filtering