mirror of
https://github.com/Kilo-Org/kilocode.git
synced 2026-09-24 16:02:55 +08:00
Merge branch 'main' into tui-usage-info
This commit is contained in:
Josh Holmer
@@ -7,8 +7,10 @@ description: "Connect a dedicated Google account to KiloClaw for access to Gmail
|
||||
|
||||
Connect a dedicated Google account to KiloClaw so it can interact with Google Workspace services — Gmail, Calendar, Drive, Docs, Sheets, Slides, Tasks, People, Forms, Chat, Classroom, and Apps Script.
|
||||
|
||||
{% callout type="warning" title="Use a standalone Google account" %}
|
||||
We strongly recommend creating a **dedicated Google account** specifically for KiloClaw rather than connecting your personal Google account. This keeps your personal data separate and gives you full control over what KiloClaw can access. Throughout this guide, "the KiloClaw Google account" refers to this dedicated account.
|
||||
{% callout type="warning" title="Use a dedicated Google account" %}
|
||||
We recommend creating a **dedicated Google account** for KiloClaw. This keeps your personal data separate and gives you full control over what KiloClaw can access.
|
||||
|
||||
If you are using Google Workspace, we recommend creating the bot account inside the Google Workspace.
|
||||
{% /callout %}
|
||||
|
||||
## What You Get
|
||||
|
||||
@@ -46,6 +46,12 @@ Before configuring, take these preflight steps:
|
||||
|
||||
1. **Create a Google Account for your Claw** — Go to [google.com](https://www.google.com/) and create a new Google/Gmail account dedicated to your KiloClaw. Something like `yourname.bot@gmail.com` works well.
|
||||
|
||||
{% callout type="tip" title="Google Workspace users" %}
|
||||
If your organization uses Google Workspace, create the dedicated bot account inside your Workspace domain (e.g., `claw@yourcompany.com`) rather than as a standalone `@gmail.com` account.
|
||||
|
||||
A Workspace-managed account benefits from your organization's admin policies, making configuration easier.
|
||||
{% /callout %}
|
||||
|
||||
2. **Set up Google Cloud** — Visit [console.cloud.google.com](https://console.cloud.google.com). Accept the terms of service and click "Start my free tier". You may need to add a credit card for identity verification.
|
||||
|
||||
{% callout type="info" %}
|
||||
|
||||
@@ -1,171 +0,0 @@
|
||||
---
|
||||
title: "Setup walkthrough"
|
||||
description: "Start-to-finish guide for configuring your KiloClaw instance"
|
||||
---
|
||||
|
||||
# Setup walkthrough
|
||||
|
||||
This guide walks you through a full KiloClaw setup — from creating accounts to scheduling your first automated workflow. Plan for about 60 minutes.
|
||||
|
||||
---
|
||||
|
||||
## Planning your setup
|
||||
|
||||
For most users, a useful KiloClaw configuration involves:
|
||||
|
||||
1. A **chat platform** (called a "channel" in OpenClaw) so you can message your Claw
|
||||
2. **Google services** for email, calendar, and Drive
|
||||
3. **GitHub** for code and markdown syncing
|
||||
|
||||
### Use dedicated accounts for your Claw
|
||||
|
||||
We recommend creating **separate accounts** for your KiloClaw rather than connecting it to your personal accounts. This applies to Google, GitHub, and any other services you connect. A dedicated account improves isolation — your personal data stays separate, and you can control exactly what access the Claw has by sharing or delegating only what you want.
|
||||
|
||||
### Chat platform options
|
||||
|
||||
- **[Kilo Chat](https://app.kilo.ai)** — available in the web app and coming soon to iOS and Android; requires zero configuration
|
||||
- **[Telegram](/docs/kiloclaw/chat-platforms/telegram)** — easy to set up, private by default
|
||||
- **[Discord](/docs/kiloclaw/chat-platforms/discord)** — moderate setup
|
||||
- **[Slack](/docs/kiloclaw/chat-platforms/slack)** — most involved setup
|
||||
|
||||
{% callout type="warning" title="Chain-of-connection security" %}
|
||||
If your Claw has access to sensitive data (like your email), be careful which chat platform you connect it to. On broadly-accessible platforms like Slack or Discord, anyone on the server could potentially message your Claw and access that data. If you're connecting sensitive integrations, use a private platform like Kilo Chat or Telegram.
|
||||
{% /callout %}
|
||||
|
||||
The steps below walk you through this configuration.
|
||||
|
||||
---
|
||||
|
||||
## Preflight Steps
|
||||
|
||||
Take these steps before configuring your Claw.
|
||||
|
||||
If you are doing a [1-1 configuration call with Kilo](https://kilo.ai/kiloclaw/config-service), please complete these steps before the call.
|
||||
|
||||
### Google
|
||||
|
||||
Configuring Google services is by far the most involved part of setting up your Claw.
|
||||
|
||||
Before configuring, take these preflight steps:
|
||||
|
||||
1. **Create a Google Account for your Claw** — Go to [google.com](https://www.google.com/) and create a new Google/Gmail account dedicated to your KiloClaw. Something like `yourname.bot@gmail.com` works well.
|
||||
|
||||
2. **Set up Google Cloud** — Visit [console.cloud.google.com](https://console.cloud.google.com). Accept the terms of service and click "Start my free tier". You may need to add a credit card for identity verification.
|
||||
|
||||
{% callout type="info" %}
|
||||
Nothing KiloClaw does costs any money with Google.
|
||||
{% /callout %}
|
||||
|
||||
3. **Install Docker** — KiloClaw configures Google by running a Docker container on your machine. Download Docker at [docker.com](https://www.docker.com/), then open it. You don't need to sign in or create a Docker account.
|
||||
|
||||
## Other Services
|
||||
|
||||
1. **Create a GitHub account for your Claw** — Using your new Gmail address, create a matching GitHub account for your Claw.
|
||||
|
||||
---
|
||||
|
||||
## Set up a messaging platform
|
||||
|
||||
Your Claw needs a way to communicate with you. **[Kilo Chat](https://app.kilo.ai)** requires no setup — just open the web app. For other platforms, follow the relevant guide:
|
||||
|
||||
- [Telegram](/docs/kiloclaw/chat-platforms/telegram) — about 2 minutes
|
||||
- [Discord](/docs/kiloclaw/chat-platforms/discord) — about 10 minutes
|
||||
- [Slack](/docs/kiloclaw/chat-platforms/slack) — about 15 minutes; always use the manifest
|
||||
|
||||
{% callout type="tip" %}
|
||||
If you're not sure which to pick, Kilo Chat (no setup) or Telegram (2 minutes) are the easiest options.
|
||||
{% /callout %}
|
||||
|
||||
---
|
||||
|
||||
## Set up Google OAuth
|
||||
|
||||
This lets your Claw act as the bot Google account — sending email, reading calendar, and more. Takes about 15 minutes.
|
||||
|
||||
Prerequisites: Docker is installed and running, and your bot Google account is already created.
|
||||
|
||||
1. In the KiloClaw dashboard, go to **Settings → Google Account** and copy the Docker command shown.
|
||||
2. Open a terminal and run the command.
|
||||
3. Follow the steps in the console:
|
||||
- At each step, confirm you're logged in to the bot account (check the top-right corner of the screen).
|
||||
- After project creation, confirm you're in the correct project.
|
||||
- The last step may look like it failed — this is expected.
|
||||
|
||||
For full details, see the [Google setup guide](/docs/kiloclaw/development-tools/google).
|
||||
|
||||
---
|
||||
|
||||
## Set up GitHub
|
||||
|
||||
A dedicated bot GitHub account is strongly recommended. Takes about 7 minutes.
|
||||
|
||||
**Create a Personal Access Token (PAT):**
|
||||
|
||||
1. In GitHub, go to **Settings → Developer Settings → Personal Access Tokens → Classic → Generate new token**.
|
||||
2. Select these scopes: `repo`, `workflow`, `write:org`, `read:user`.
|
||||
|
||||
For full details, see the [GitHub setup guide](/docs/kiloclaw/development-tools/github).
|
||||
|
||||
**Set up a private workspace repo:**
|
||||
|
||||
Once GitHub is connected, ask your Claw to back up its workspace:
|
||||
|
||||
```
|
||||
Use your GitHub access to back up your workspace. Make it a GitHub repo and push it as a private repo. Add me as a member so I can see it. Then set up a cron job to pull, rebase, and push any changes at least once an hour.
|
||||
```
|
||||
|
||||
After sending that, redeploy from the dashboard to pick up the changes.
|
||||
|
||||
---
|
||||
|
||||
## Grant email and calendar access
|
||||
|
||||
After OAuth is set up, decide how much access to give your Claw to your personal accounts.
|
||||
|
||||
| Option | What it does | Best for | Configured from |
|
||||
| ----------------------- | --------------------------------------------------------------------- | ------------------------------------------ | ------------------------------------------------------- |
|
||||
| Forward select emails | A Gmail filter forwards specific senders or labels to the bot account | Targeted use cases like newsletter digests | Your personal account |
|
||||
| Forward all email | Forwards your full inbox to the bot | Simpler setups where noise is acceptable | Bot account (destination) |
|
||||
| Full account delegation | Gives the bot direct read/write access to your personal account | Maximum capability | Your personal account — Gmail Settings → Add a delegate |
|
||||
|
||||
{% callout type="info" %}
|
||||
Email forwarding is configured from the **destination** (bot) account. Account delegation is configured from the **source** (personal) account.
|
||||
{% /callout %}
|
||||
|
||||
**Push notifications:** by default, your Claw wakes up on every incoming email. If you'd prefer a digest (e.g., once at 7am), disable push notifications in **Settings → Google Account** on the [dashboard](/docs/kiloclaw/dashboard) — otherwise it processes each email as it arrives.
|
||||
|
||||
**Google Calendar:** share your personal calendar from your personal Google account. Go to **Google Calendar → Settings → Settings for my calendars → [your calendar] → Share with specific people**, and add the bot account.
|
||||
|
||||
---
|
||||
|
||||
## Enable auto-approval
|
||||
|
||||
By default, KiloClaw asks for confirmation before every tool call. To let it act freely, go to the [KiloClaw dashboard](https://app.kilo.ai/claw) and enable auto-approval in the **Default Permissions** section.
|
||||
|
||||
---
|
||||
|
||||
## Prompt and schedule work
|
||||
|
||||
**How to prompt your Claw:** just tell it in plain language what you want. Be specific. If you want it to remember something across sessions, tell it to write it down in a specific file.
|
||||
|
||||
**Scheduling jobs:** tell your Claw when and what to do — for example:
|
||||
|
||||
```
|
||||
Every day at 7am, summarize my emails and send me a digest.
|
||||
```
|
||||
|
||||
Mentioning "cron job" helps it understand you want a recurring scheduled task.
|
||||
|
||||
**Skills:** the OpenClaw Skills hub has pre-built capabilities you can add. The easiest way to install a skill is to just ask your Claw by name:
|
||||
|
||||
```
|
||||
Install the [skill name] skill.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Manage inference
|
||||
|
||||
**Model picker:** Balanced is a good starting point. Frontier is more capable but significantly more expensive.
|
||||
|
||||
You can also use your KiloPass credits — find this under **Profile** in the dashboard.
|
||||
@@ -825,4 +825,14 @@ module.exports = [
|
||||
basePath: false,
|
||||
permanent: true,
|
||||
},
|
||||
|
||||
// ============================================
|
||||
// KILOCLAW
|
||||
// ============================================
|
||||
{
|
||||
source: "/docs/kiloclaw/suggested-configuration",
|
||||
destination: "/docs/kiloclaw/end-to-end",
|
||||
basePath: false,
|
||||
permanent: true,
|
||||
},
|
||||
]
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Source Code Links
|
||||
|
||||
<!-- Auto-generated by script/extract-source-links.ts — DO NOT EDIT -->
|
||||
<!-- 77 unique URLs extracted from extension and CLI source -->
|
||||
<!-- 78 unique URLs extracted from extension and CLI source -->
|
||||
|
||||
- <https://api.apertis.ai/v1>
|
||||
<!-- packages/opencode/src/provider/model-cache.ts -->
|
||||
@@ -55,6 +55,8 @@
|
||||
<!-- packages/kilo-vscode/webview-ui/src/components/settings/AboutKiloCodeTab.tsx -->
|
||||
- <https://github.com/Kilo-Org/kilocode/issues/6986>
|
||||
<!-- packages/kilo-vscode/src/agent-manager/constants.ts -->
|
||||
- <https://github.com/Kilo-Org/kilocode/issues/new?template=bug-report.yml>
|
||||
<!-- packages/opencode/src/cli/cmd/tui/app.tsx -->
|
||||
- <https://github.com/Kilo-Org/kilocode/issues/new/choose>
|
||||
<!-- packages/kilo-vscode/webview-ui/src/components/chat/FeedbackDialog.tsx -->
|
||||
- <https://github.com/microsoft/vscode-eslint/archive/refs/heads/main.zip>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import { render, TimeToFirstDraw, useKeyboard, useRenderer, useTerminalDimensions } from "@opentui/solid"
|
||||
import { Clipboard } from "@tui/util/clipboard"
|
||||
import { Selection } from "@tui/util/selection"
|
||||
import { createCliRenderer, MouseButton, type CliRendererConfig } from "@opentui/core"
|
||||
import { createCliRenderer, MouseButton, TextAttributes, type CliRendererConfig } from "@opentui/core" // kilocode_change
|
||||
import { RouteProvider, useRoute } from "@tui/context/route"
|
||||
import {
|
||||
Switch,
|
||||
@@ -16,12 +16,12 @@ import {
|
||||
on,
|
||||
onCleanup,
|
||||
} from "solid-js"
|
||||
import { win32DisableProcessedInput, win32InstallCtrlCGuard } from "./win32"
|
||||
import { win32DisableProcessedInput, win32FlushInputBuffer, win32InstallCtrlCGuard } from "./win32" // kilocode_change
|
||||
import { Flag } from "@/flag/flag"
|
||||
import semver from "semver"
|
||||
import { DialogProvider, useDialog } from "@tui/ui/dialog"
|
||||
import { DialogProvider as DialogProviderList } from "@tui/component/dialog-provider"
|
||||
import { ErrorComponent } from "@tui/component/error-component"
|
||||
import { Installation } from "@/installation" // kilocode_change
|
||||
import { PluginRouteMissing } from "@tui/component/plugin-route-missing"
|
||||
import { SDKProvider, useSDK } from "@tui/context/sdk"
|
||||
import { StartupLoading } from "@tui/component/startup-loading"
|
||||
@@ -202,9 +202,11 @@ export function tui(input: {
|
||||
await render(() => {
|
||||
return (
|
||||
<ErrorBoundary
|
||||
// kilocode_change start
|
||||
fallback={(error, reset) => (
|
||||
<ErrorComponent error={error} reset={reset} onBeforeExit={onBeforeExit} onExit={onExit} mode={mode} />
|
||||
)}
|
||||
// kilocode_change end
|
||||
>
|
||||
<ArgsProvider {...input.args}>
|
||||
<ExitProvider onBeforeExit={onBeforeExit} onExit={onExit}>
|
||||
@@ -965,7 +967,122 @@ function App(props: { onSnapshot?: () => Promise<string[]> }) {
|
||||
</Show>
|
||||
{plugin()}
|
||||
<TuiPluginRuntime.Slot name="app" />
|
||||
{/* kilocode_change start */}
|
||||
<StartupLoading ready={ready} />
|
||||
</box>
|
||||
)
|
||||
}
|
||||
// kilocode_change end
|
||||
|
||||
// kilocode_change start — guard against missing renderer context in ErrorBoundary fallback
|
||||
function tryUseRenderer() {
|
||||
try {
|
||||
return useRenderer()
|
||||
} catch {
|
||||
return undefined
|
||||
}
|
||||
}
|
||||
|
||||
function tryUseTerminalDimensions() {
|
||||
try {
|
||||
return useTerminalDimensions()
|
||||
} catch {
|
||||
return undefined
|
||||
}
|
||||
}
|
||||
// kilocode_change end
|
||||
|
||||
// kilocode_change start — inlined ErrorComponent with safe renderer/keyboard guards
|
||||
function ErrorComponent(props: {
|
||||
error: Error
|
||||
reset: () => void
|
||||
onBeforeExit?: () => Promise<void>
|
||||
onExit: () => Promise<void>
|
||||
mode?: "dark" | "light"
|
||||
}) {
|
||||
const term = tryUseTerminalDimensions()
|
||||
const renderer = tryUseRenderer()
|
||||
|
||||
const height = () => term?.().height ?? process.stdout.rows ?? 24
|
||||
|
||||
const handleExit = async () => {
|
||||
await props.onBeforeExit?.()
|
||||
renderer?.setTerminalTitle("")
|
||||
renderer?.destroy()
|
||||
win32FlushInputBuffer()
|
||||
await props.onExit()
|
||||
}
|
||||
|
||||
try {
|
||||
useKeyboard((evt) => {
|
||||
if (evt.ctrl && evt.name === "c") {
|
||||
handleExit()
|
||||
}
|
||||
})
|
||||
} catch {
|
||||
// Keyboard handler unavailable — renderer context may be missing.
|
||||
// Ctrl+C will still work via the default signal handler.
|
||||
}
|
||||
|
||||
const [copied, setCopied] = createSignal(false)
|
||||
|
||||
const issueURL = new URL("https://github.com/Kilo-Org/kilocode/issues/new?template=bug-report.yml")
|
||||
|
||||
// Choose safe fallback colors per mode since theme context may not be available
|
||||
const isLight = props.mode === "light"
|
||||
const colors = {
|
||||
bg: isLight ? "#ffffff" : "#0a0a0a",
|
||||
text: isLight ? "#1a1a1a" : "#eeeeee",
|
||||
muted: isLight ? "#8a8a8a" : "#808080",
|
||||
primary: isLight ? "#3b7dd8" : "#fab283",
|
||||
}
|
||||
|
||||
if (props.error.message) {
|
||||
issueURL.searchParams.set("title", `opentui: fatal: ${props.error.message}`)
|
||||
}
|
||||
|
||||
if (props.error.stack) {
|
||||
issueURL.searchParams.set(
|
||||
"description",
|
||||
"```\n" + props.error.stack.substring(0, 6000 - issueURL.toString().length) + "...\n```",
|
||||
)
|
||||
}
|
||||
|
||||
issueURL.searchParams.set("opencode-version", Installation.VERSION)
|
||||
|
||||
const copyIssueURL = () => {
|
||||
Clipboard.copy(issueURL.toString()).then(() => {
|
||||
setCopied(true)
|
||||
})
|
||||
}
|
||||
|
||||
return (
|
||||
<box flexDirection="column" gap={1} backgroundColor={colors.bg}>
|
||||
<box flexDirection="row" gap={1} alignItems="center">
|
||||
<text attributes={TextAttributes.BOLD} fg={colors.text}>
|
||||
Please report an issue.
|
||||
</text>
|
||||
<box onMouseUp={copyIssueURL} backgroundColor={colors.primary} padding={1}>
|
||||
<text attributes={TextAttributes.BOLD} fg={colors.bg}>
|
||||
Copy issue URL (exception info pre-filled)
|
||||
</text>
|
||||
</box>
|
||||
{copied() && <text fg={colors.muted}>Successfully copied</text>}
|
||||
</box>
|
||||
<box flexDirection="row" gap={2} alignItems="center">
|
||||
<text fg={colors.text}>A fatal error occurred!</text>
|
||||
<box onMouseUp={props.reset} backgroundColor={colors.primary} padding={1}>
|
||||
<text fg={colors.bg}>Reset TUI</text>
|
||||
</box>
|
||||
<box onMouseUp={handleExit} backgroundColor={colors.primary} padding={1}>
|
||||
<text fg={colors.bg}>Exit</text>
|
||||
</box>
|
||||
</box>
|
||||
<scrollbox height={Math.floor(height() * 0.7)}>
|
||||
<text fg={colors.muted}>{props.error.stack}</text>
|
||||
</scrollbox>
|
||||
<text fg={colors.text}>{props.error.message}</text>
|
||||
</box>
|
||||
)
|
||||
}
|
||||
// kilocode_change end
|
||||
|
||||
Reference in New Issue
Block a user