feat: add web search hint to onboarding
This commit is contained in:
@@ -24,6 +24,10 @@ Follow‑up reconfiguration:
|
|||||||
clawdbot configure
|
clawdbot configure
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Recommended: set up a Brave Search API key so the agent can use `web_search`
|
||||||
|
(`web_fetch` works without a key). Set `BRAVE_API_KEY` or
|
||||||
|
`tools.web.search.apiKey`. Docs: [Web tools](/tools/web).
|
||||||
|
|
||||||
## QuickStart vs Advanced
|
## QuickStart vs Advanced
|
||||||
|
|
||||||
The wizard starts with **QuickStart** (defaults) vs **Advanced** (full control).
|
The wizard starts with **QuickStart** (defaults) vs **Advanced** (full control).
|
||||||
|
|||||||
@@ -24,6 +24,15 @@ These are **not** browser automation. For JS-heavy sites or logins, use the
|
|||||||
(HTML → markdown/text). It does **not** execute JavaScript.
|
(HTML → markdown/text). It does **not** execute JavaScript.
|
||||||
- In sandboxed sessions, `web_fetch` is enabled automatically (unless explicitly disabled).
|
- In sandboxed sessions, `web_fetch` is enabled automatically (unless explicitly disabled).
|
||||||
|
|
||||||
|
## Getting a Brave API key
|
||||||
|
|
||||||
|
1) Create a Brave Search API account at https://brave.com/search/api/
|
||||||
|
2) Generate an API key in the dashboard.
|
||||||
|
3) Set `BRAVE_API_KEY` in your environment or paste it into `tools.web.search.apiKey`.
|
||||||
|
|
||||||
|
Brave provides a free tier plus paid plans; check the Brave API portal for the
|
||||||
|
current limits and pricing.
|
||||||
|
|
||||||
## web_search
|
## web_search
|
||||||
|
|
||||||
Search the web with Brave’s API.
|
Search the web with Brave’s API.
|
||||||
@@ -92,12 +101,3 @@ Notes:
|
|||||||
- `web_fetch` is best-effort extraction; some sites will need the browser tool.
|
- `web_fetch` is best-effort extraction; some sites will need the browser tool.
|
||||||
- Responses are cached (default 15 minutes) to reduce repeated fetches.
|
- Responses are cached (default 15 minutes) to reduce repeated fetches.
|
||||||
- If you use tool profiles/allowlists, add `web_search`/`web_fetch` or `group:web`.
|
- If you use tool profiles/allowlists, add `web_search`/`web_fetch` or `group:web`.
|
||||||
|
|
||||||
## Getting a Brave API key
|
|
||||||
|
|
||||||
1) Create a Brave Search API account at https://brave.com/search/api/
|
|
||||||
2) Generate an API key in the dashboard.
|
|
||||||
3) Set `BRAVE_API_KEY` in your environment or paste it into `tools.web.search.apiKey`.
|
|
||||||
|
|
||||||
Brave provides a free tier plus paid plans; check the Brave API portal for the
|
|
||||||
current limits and pricing.
|
|
||||||
|
|||||||
@@ -110,4 +110,10 @@ export async function runNonInteractiveOnboardingLocal(params: {
|
|||||||
skipSkills: Boolean(opts.skipSkills),
|
skipSkills: Boolean(opts.skipSkills),
|
||||||
skipHealth: Boolean(opts.skipHealth),
|
skipHealth: Boolean(opts.skipHealth),
|
||||||
});
|
});
|
||||||
|
|
||||||
|
if (!opts.json) {
|
||||||
|
runtime.log(
|
||||||
|
"Tip: set BRAVE_API_KEY (or tools.web.search.apiKey) to enable web_search. Docs: https://docs.clawd.bot/tools/web",
|
||||||
|
);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -44,5 +44,8 @@ export async function runNonInteractiveOnboardingRemote(params: {
|
|||||||
} else {
|
} else {
|
||||||
runtime.log(`Remote gateway: ${remoteUrl}`);
|
runtime.log(`Remote gateway: ${remoteUrl}`);
|
||||||
runtime.log(`Auth: ${payload.auth}`);
|
runtime.log(`Auth: ${payload.auth}`);
|
||||||
|
runtime.log(
|
||||||
|
"Tip: set BRAVE_API_KEY (or tools.web.search.apiKey) to enable web_search. Docs: https://docs.clawd.bot/tools/web",
|
||||||
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -75,6 +75,14 @@ export async function runOnboardingWizard(
|
|||||||
) {
|
) {
|
||||||
printWizardHeader(runtime);
|
printWizardHeader(runtime);
|
||||||
await prompter.intro("Clawdbot onboarding");
|
await prompter.intro("Clawdbot onboarding");
|
||||||
|
await prompter.note(
|
||||||
|
[
|
||||||
|
"Recommended: get a Brave Search API key to enable web_search.",
|
||||||
|
"Set BRAVE_API_KEY or tools.web.search.apiKey.",
|
||||||
|
"Docs: https://docs.clawd.bot/tools/web",
|
||||||
|
].join("\n"),
|
||||||
|
"Web search (optional)",
|
||||||
|
);
|
||||||
await requireRiskAcknowledgement({ opts, prompter });
|
await requireRiskAcknowledgement({ opts, prompter });
|
||||||
|
|
||||||
const snapshot = await readConfigFileSnapshot();
|
const snapshot = await readConfigFileSnapshot();
|
||||||
|
|||||||
Reference in New Issue
Block a user