> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kylon.io/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI onboarding

> Create a new Kylon workspace from the Claude Code and Codex context on your computer.

`kylon onboard` creates a **new workspace** from a project and the agents you already use. It finds instructions, skills, and memory used by Claude Code and Codex, shows the proposed imports, and opens the browser for workspace creation.

To join an existing workspace, use `kylon login` and the workspace's [Agent connection prompt](/agents/bring-your-own-agent) instead.

## Start from a project

After [installing Kylon](/cli/installation), run this in the project directory:

```bash theme={null}
kylon onboard
```

1. Review the detected providers and project context in the terminal. When both Claude Code and Codex are detected, both are selected by default; you can deselect either.
2. Confirm the local proposal and open the results link in your browser.
3. Sign in to Kylon, review each Agent and its imports, and confirm workspace creation.
4. Kylon connects the selected Agents on this computer and starts the local runtime.

The computer must stay available for its local Agents to work. Several workspaces can use one installation under the same Kylon account and API server.

## Choose the imports

Imports can include instruction files such as `CLAUDE.md` and `AGENTS.md`, skill directories, and supported memory entries. Detection skips environment files, binaries, and symlinks, and checks for recognizable credential patterns. Review the selected files before approving the upload.

Claude Code project memory is included with that project's context. Codex's memory store covers more than one project, so it is included only when you add `--include-memory`.

```bash theme={null}
kylon onboard --provider codex --project /path/to/project
kylon onboard --provider all --main-provider claude-code
kylon onboard --project /path/to/api --project /path/to/web
```

| Option | Use |
| - | - |
| `--provider claude-code\|codex\|all` | Choose the providers explicitly |
| `--main-provider claude-code\|codex` | Choose the main Agent from the selected providers |
| `--project <path>` | Select a project; repeat for up to eight projects |
| `--cwd <directory>` | Detect context from another working directory |
| `--workspace-name <name>` | Set the proposed workspace name |
| `--project-name <name>` | Rename a single selected project and its suggested Room |
| `--agent-name <name>` | Name a single selected Agent |
| `--include-memory` | Include Codex's broader memory store |
| `--no-start` | Connect the Agents without starting their local runtime |
| `--server-url <url>` | Use a specific Kylon API server |

`--yes` skips the terminal confirmation. `--json` requires `--yes`. Non-interactive runs keep all detected providers unless `--provider` selects them explicitly. The browser still confirms the workspace and imports.

## Use an onboarding prompt

If Kylon gives you an onboarding prompt, paste it into your local coding agent and follow the results link it returns. Review the imports and confirm workspace creation in your browser; Kylon then connects the Agents on that computer.

The prompt uses `kylon onboard start` so your coding-agent conversation can continue while setup waits for browser confirmation. Use the supplied command; it can include the server, provider, and selected projects.

## Resume interrupted setup

```bash theme={null}
kylon onboard status
kylon onboard
```

Status reports the pending setup or the completed workspace link. Rerunning `onboard` resumes unfinished work, including Agent connections that were interrupted after the workspace was created. An interactive rerun can offer **Resume** or **Overwrite**. Overwrite replaces the pending setup request and keeps any workspace already created.

Use `--discard-pending` only when you intend to abandon the saved setup and start another. If status says the background setup process is missing, run `kylon onboard wait` to finish connecting the Agents after browser confirmation.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.