Skip to content

Onboarding Wizard

When you first install CodeBuddy, the onboarding wizard walks you through initial setup in five steps. It auto-detects your project’s languages and frameworks, tests provider connectivity, and configures security defaults.

Introduction to CodeBuddy’s capabilities. No configuration required — just proceed.

Choose your LLM provider and enter your API key:

ProviderConfig keyDefault model
Anthropicanthropic.apiKeyClaude Sonnet 4.5
OpenAIopenai.apiKeyGPT-4o
Google Geminigoogle.gemini.apiKeysGemini 2.5 Pro
Groqgroq.llama3.apiKeyLlama 3.1 70B
DeepSeekdeepseek.apiKeyDeepSeek Chat
Qwenqwen.apiKeyQwen Max
GLMglm.apiKeyGLM-4
Local/Ollamalocal.baseUrlQwen 2.5 Coder

The wizard tests the provider after you enter your key — it makes a short API call and reports latency. If the test fails, you can try a different provider.

The wizard analyzes your workspace to detect:

  • Languages — Looks for indicator files: tsconfig.json → TypeScript, requirements.txt → Python, go.mod → Go, Cargo.toml → Rust, etc.
  • Frameworks — Checks package.json dependencies (React, Next.js, Vue, Angular, Express, NestJS) and Python requirements (FastAPI, Django, Flask)
  • Git — Whether the workspace is a git repository
  • Docker — Whether Dockerfile or docker-compose.yml exists
  • Package manager — npm, yarn, pnpm, pip, or poetry

This information is stored as project context and used to tailor agent responses.

Configures the default permission profile:

  • Restricted — Read-only, no terminal, no file writes
  • Standard — Read/write with safe terminal commands (default)
  • Trusted — Full access with auto-approval

Suggests a first task based on your detected project type:

  • For existing projects: “Analyze my codebase architecture”
  • For new projects: “Help me set up the project structure”
CodeBuddy: Show Onboarding Wizard

The wizard tracks completion state in the editor’s global storage with a version number. When the wizard version is bumped in an update, it will re-show automatically to cover new setup steps.

LanguageIndicator files
TypeScripttsconfig.json, .ts
JavaScriptpackage.json, .js, .mjs
Pythonrequirements.txt, pyproject.toml, setup.py, .py
Javapom.xml, build.gradle, .java
Gogo.mod, go.sum, .go
RustCargo.toml, .rs
PHPcomposer.json, .php
RubyGemfile, .rb
C#.csproj, .sln, .cs
SwiftPackage.swift, .swift
FrameworkDependencies
Reactreact, react-dom
Next.jsnext
Vuevue
Angular@angular/core
Expressexpress
NestJS@nestjs/core
FrameworkPackage
FastAPIfastapi
Djangodjango
Flaskflask