Skip to content
my-buddy

Installation

Prerequisites

Section titled “Prerequisites”
ToolVersionPurpose
Bun1.0+Runtime and package manager
Git2.0+Version control
Claude CodeLatestAI persona commands

Method 1: Template (Clone and Own)

Section titled “Method 1: Template (Clone and Own)”

The fastest way to get started:

Terminal window
git clone https://github.com/mayknxyz/my-buddy.git
cd my-buddy
bun install

Method 2: CLI Scaffold

Section titled “Method 2: CLI Scaffold”
Terminal window
bun create my-buddy

The CLI asks for your persona name, tone, which collections to enable, accent color, and sets everything up.

Section titled “Method 3: Fork Workflow (Recommended)”

Best for staying updated with upstream changes:

  1. Fork the repo on GitHub

    Go to github.com/mayknxyz/my-buddy and click Fork.

  2. Clone your fork

    Terminal window
    git clone https://github.com/YOUR_USERNAME/my-buddy.git
    cd my-buddy
    bun install

  3. Add upstream remote

    Terminal window
    git remote add upstream https://github.com/mayknxyz/my-buddy.git

  4. Pull code updates anytime

    Terminal window
    git fetch upstream
    git merge upstream/main

Setup

Section titled “Setup”

After installing, copy the example config:

Terminal window
cp buddy.config.example.ts buddy.config.ts

See Configuration for all available options.

Verify Installation

Section titled “Verify Installation”
Terminal window
bun dev

Open localhost:4321. You should see the dashboard with empty collections ready to populate.

Troubleshooting

Section titled “Troubleshooting”