setup

Files (15)

• SKILL.md
• beads-conventions.md · rules-templates/
• commit-pr-conventions.md · rules-templates/
• dev-defaults.md · rules-templates/
• secrets.md · rules-templates/
• detect-env.py · scripts/
• install-obsidian-plugins.py · scripts/
• migrate-apple-notes.py · scripts/
• migrate-notion.py · scripts/
• migrate-onenote.py · scripts/
• provision-formulas.py · scripts/
• scaffold.py · scripts/
• scan-projects.py · scripts/
• settings-writer.py · scripts/
• setup.md · workflows/

SKILL.md (first lines)

# Setup Skill

Onboarding wizard that turns an empty machine into a fully wired second brain.
User types 4 things. Everything else is auto-detected, researched, or confirmed with a Yes/No popup.

## Required Toolchain

Braynee has hard dependencies. Setup verifies all of them up front (Step 1A) and
guides cross-platform installation for any that are missing — **none are assumed
to exist**:

| Tool | Why it's required |
|---|---|
| `git` | Vault is a git repo; the plugin configures Obsidian Git auto-commit/push |
| `node` | Runs every braynee hook, monitor, and bundled script |
| `python3` | Runs the setup, scaffold, and migration scripts |
| `bd` | Beads issue tracking is mandatory for all code projects |
| QMD | Search index (ships via the bundled `qmd-wrapper.mjs`) |

If any are missing, setup offers to install them (OS-appropriate commands) or
stops with instructions — it never silently proceeds and fails later.

## What It Does

1. Verifies required toolchain (git, node, python3, bd, QMD) — installs/guides if missing
2. Collects 4 inputs: name, company, website, social handle
3. Scans filesystem for git repos (all folder names, not just ~/code)
4. Runs web research sub-agent to seed company knowledge
5. Scaffolds PARA vault + company structure + PRD section + Development section
6. Installs Obsidian community plugins
7. Initializes Git, Beads, QMD — and provisions braynee's workflow formulas (autonomous-ship, project, engagement, braynee-release) into `~/.beads/formulas/` so `bd mol pour` works with no manual copy
8. Migrates notes from detected source apps (Apple Notes, Notion, OneNote)
9. Writes CLAUDE.md seeded with user context

## Workflow

See `workflows/setup.md` for the full step-by-step process.

## Usage

```
/setup
/setup --reset          # Re-run, overwrite existing structure
/setup --company-only   # Only scaffold company section
/setup --projects-only  # Only scan and scaffold projects
```

## Inputs Collected

| # | Question | Used for |
|---|---|---|
| 1 | Your name | CLAUDE.md personalization |
| 2 | Company name (or "personal") | Business folder naming, web research |
| 3 | Company website URL | Research sub-agent seed |
| 4 | LinkedIn or Twitter/X handle (optional) | Personal CLAUDE.md context |

## Auto-Detected (No Questions)

- OS (Mac/Windows)
- Email platform (check installed apps / default mail handler)
- Existing note apps (Apple Notes, Notion, OneNote)
- Obsidian vault path (search for .obsidian folder)
- Git repos (deep scan, all folder names)
- Tech stack per repo (package.json, requirements.txt, etc.)
- Calendar platform (Apple Calendar, Google Calendar)

## Obsidian Plugins Installed

Plugin IDs must match the plugin's own `manifest.json` id exactly — this is also the
folder name under `.obsidian/plugins/` and the entry in `community-plugins.json`.

| Plugin | Correct ID | Key settings written |
|---|---|---|
| Dataview | `dataview` | inline queries, refresh enabled |
| Templater | `templater-obsidian` | template folder → `3. Resources/Templates` |
| Calendar | `calendar` | week starts Monday |
| Obsidian Git | `obsidian-git` | auto-commit every 10min, auto-push, auto-pull on boot |
| Excalidraw | `obsidian-excalidraw-plugin` | drawings folder → `2. Areas/Excalidraw` |

Per-plugin settings are written to `.obsidian/plugins/<id>/data.json`.
Existing `data.json` files are never overwritten (user customizations preserved).

### Restricted Mode — One-Time Manual Step

Community plugins require "restricted mode" to be OFF. This is stored inside Obsidian's
internal database (not in vault files), so it cannot be set programmatically.

The setup wizard checks if plugins are already active. If not, it shows a popup:

> **Action required:**
> Open Obsidian → Settings → Community plugins → click **"Turn on community plugins"**
> Then come back and press Yes to continue.

This is a one-time step per vault.

## Structure Built

```
<vault>/
├── 1. Projects/                    ← PARA personal/client projects
├── 2. Areas/
│   ├── Product Manager/
│   │   ├── PRDs/
│   │   ├── Roadmaps/
│   │   ├── Research/
│   │   ├── Launches/
│   │   └── Metrics/
│   ├── Development/                ← only frameworks detected in repos
│   ├── Business/
│   │   └── <CompanyName>/
│   │       ├── Org/
│   │       │   ├── Decisions/
│   │       │   ├── Strategy/      ← seeded from website
│   │       │   ├── Competitors/   ← seeded from web research
│   │       │   ├── Pipeline/
│   │       │   └── Risks/
│   │       ├── Teams/
│   │       │   ├── Engineering/
│   │       │   ├── Marketing/

From hamchowderr/braynee, MIT.

More from hamchowderr/braynee