mirror of
https://github.com/Kilo-Org/kilocode.git
synced 2026-09-24 16:02:55 +08:00
docs(kilo-docs): revise workspace migration FAQ to cover all migration scenarios
Rewrite the migration section to explicitly cover three use cases: - Migrating from another OpenClaw provider to KiloClaw - Moving between KiloClaw instances (individual to org or vice versa) - Leaving KiloClaw for another OpenClaw provider Clarify that the process is the same for all three, and distinguish what migrates via backup/restore (workspace files, memory, context) from what needs manual reconfiguration (integrations).
This commit is contained in:
kiloconnect[bot]
@@ -26,63 +26,56 @@ Do **not** click **Update Now** inside the OpenClaw Control UI — this is not s
|
||||
|
||||
Updates are managed by the KiloClaw platform team to ensure stability. When a new version is available, it will be announced in the **Changelog** on your dashboard. To apply the update, click **Upgrade & Redeploy** from the [KiloClaw Dashboard](/docs/kiloclaw/dashboard#redeploy).
|
||||
|
||||
## How do I migrate my workspace to a new instance?
|
||||
## How do I migrate my workspace?
|
||||
|
||||
When switching from one KiloClaw instance to another — or to a different OpenClaw provider — you can migrate your Claw's workspace (including memory and other files) by transferring the workspace directory. Integrations you've configured (Google, GitHub, GitLab, Linear, Telegram, etc.) will need to be set up again manually on the new instance.
|
||||
Whether you're migrating from another OpenClaw provider to KiloClaw, moving between KiloClaw instances (e.g., individual to org or vice versa), or leaving KiloClaw for another OpenClaw provider, the process is the same:
|
||||
|
||||
### What migrates and what doesn't?
|
||||
1. **Back up** your workspace files from your current Claw.
|
||||
2. **Set up** your new provider or KiloClaw instance.
|
||||
3. **Restore** the workspace files on the new Claw.
|
||||
4. **Reconfigure** your integrations on the new instance.
|
||||
|
||||
- **Migrates** — Workspace files, memory, context, and any data stored in the workspace directory.
|
||||
- **Does not migrate** — Integrations and authentication tokens (Google Workspace, GitHub, GitLab, Linear, Telegram, Discord, Slack, etc.). These must be reconfigured on the new instance.
|
||||
### What migrates automatically vs. what doesn't
|
||||
|
||||
{% callout type="info" %}
|
||||
Your Claw's workspace memory and context carry over with the workspace files, so your new instance will retain the same knowledge and preferences as before.
|
||||
{% /callout %}
|
||||
- **Migrates via backup/restore** — Workspace files, memory, and context. Your new Claw retains the same knowledge and preferences as before.
|
||||
- **Requires manual reconfiguration** — Integrations and authentication tokens (Google, GitHub, GitLab, Linear, Telegram, Discord, Slack, etc.). These are tied to the instance and must be set up fresh.
|
||||
|
||||
### Backing up your workspace
|
||||
|
||||
The recommended approach is to have your Claw save its workspace externally, then restore it on the new instance. There are two options:
|
||||
Have your current Claw export the workspace before switching. Two options:
|
||||
|
||||
#### Option 1: Back up to GitHub
|
||||
|
||||
Ask your Claw to push the workspace to a GitHub repository:
|
||||
**GitHub export** — Ask your Claw:
|
||||
|
||||
> Create a new GitHub repo and push your entire workspace there with the `gh` CLI. Tell me the URL of the repo you used.
|
||||
|
||||
#### Option 2: Manual export (Google Drive)
|
||||
|
||||
Ask your Claw to compress and upload the workspace to Google Drive:
|
||||
**Manual download** — Ask your Claw:
|
||||
|
||||
> Tar compress your workspace and push the file to Google Drive with the `gog` CLI. Then share the filename you used.
|
||||
|
||||
### Restoring your workspace
|
||||
### Restoring on the new instance
|
||||
|
||||
Once you have a backup, start your new KiloClaw instance and ask the Claw to restore the workspace.
|
||||
On your new Claw, restore the workspace from whichever backup method you used:
|
||||
|
||||
#### Restore from GitHub
|
||||
**From GitHub:**
|
||||
|
||||
> The GitHub repo `<repo>` has a backup of your workspace in it. Please pull the workspace from the repo with the `gh` CLI and overwrite the existing workspace directory with the repo's contents.
|
||||
> The GitHub repo `<repo>` has a backup of your workspace. Pull the workspace from the repo with the `gh` CLI and overwrite the existing workspace directory with the repo's contents.
|
||||
|
||||
#### Restore from Google Drive
|
||||
**From Google Drive:**
|
||||
|
||||
> The Google Drive file `<filename>` has a backup of your workspace in it. Please pull the tar file from Google Drive with the `gog` CLI and overwrite the existing workspace directory with its contents.
|
||||
> The Google Drive file `<filename>` has a backup of your workspace. Pull the tar file from Google Drive with the `gog` CLI and overwrite the existing workspace directory with its contents.
|
||||
|
||||
{% callout type="note" %}
|
||||
Replace `<repo>` or `<filename>` with the actual repository URL or filename from the backup step.
|
||||
{% /callout %}
|
||||
|
||||
### Reconfiguring integrations after migration
|
||||
### Reconfiguring integrations
|
||||
|
||||
After restoring your workspace, you will need to reconfigure each integration manually:
|
||||
After restoring your workspace, set up each integration on the new instance:
|
||||
|
||||
1. **Google Workspace** — Re-authenticate with Google. See [Google integration setup](/docs/kiloclaw/development-tools/google).
|
||||
2. **GitHub** — Re-authenticate with GitHub. See [GitHub integration setup](/docs/kiloclaw/development-tools/github).
|
||||
3. **GitLab** — Re-add your GitLab token or SSH key.
|
||||
4. **Linear** — Re-add your Linear API token.
|
||||
5. **Telegram / Discord / Slack** — Re-enter your bot tokens in the [KiloClaw Dashboard Settings](/docs/kiloclaw/dashboard#channels) and redeploy.
|
||||
- **Google Workspace** — Re-authenticate with Google. See [Google integration setup](/docs/kiloclaw/development-tools/google).
|
||||
- **GitHub** — Re-authenticate with GitHub. See [GitHub integration setup](/docs/kiloclaw/development-tools/github).
|
||||
- **GitLab** — Re-add your GitLab token or SSH key.
|
||||
- **Linear** — Re-add your Linear API token.
|
||||
- **Telegram / Discord / Slack** — Re-enter your bot tokens in the [KiloClaw Dashboard Settings](/docs/kiloclaw/dashboard#channels) and redeploy.
|
||||
|
||||
See [Development Tools](/docs/kiloclaw/development-tools) and [Chat Platforms](/docs/kiloclaw/chat-platforms) for full setup instructions.
|
||||
|
||||
{% callout type="warning" %}
|
||||
Workspace migration transfers files only. Integration tokens and OAuth sessions are not included in the workspace directory and must be set up fresh on the new instance.
|
||||
{% /callout %}
|
||||
See [Development Tools](/docs/kiloclaw/development-tools) and [Chat Platforms](/docs/kiloclaw/chat-platforms) for full setup guides.
|
||||
|
||||
Reference in New Issue
Block a user