Skip to content

Commit 294eb9d

Browse files
docs(onboarding): add guides for Cursor and Claude Code tools (#3874)
1 parent 8c4f969 commit 294eb9d

File tree

8 files changed

+439
-4
lines changed

8 files changed

+439
-4
lines changed

apps/web/content/handbook/onboarding/0.getting-started.mdx

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,36 @@ When you join, you'll get access to:
1515
- **Infisical** — Ask a team member for an invite. We use [Infisical](https://infisical.com) to manage environment variables and secrets for development.
1616
- **Hyprnote admin** — Sign in at `https://hyprnote.com/admin` with your authorized email for content management.
1717

18-
### Dev Environment
18+
### Tools Setup
1919

20-
We recommend [Cursor](https://cursor.com) if you don't have a specific IDE preference. Other tools we use: Zed, GitButler, Claude Code.
20+
Everyone at Hyprnote works from the same repo and ships through the same workflow. Whether you're an engineer, designer, or marketer — you'll need most of these tools. Each links to a setup guide that explains what it is, why we use it, and how to install it.
2121

22-
[Cursor Visual Editor walkthrough](https://www.youtube.com/watch?v=XOtHjA8THCw)
22+
**Foundations (Everyone)**
23+
24+
- [ ] [Homebrew](/handbook/onboarding/homebrew) — Mac package manager. You'll use this to install almost everything else.
25+
- [ ] [Warp](/handbook/onboarding/warp) — Our recommended terminal. This is where you run commands.
26+
- [ ] [Node.js & pnpm](/handbook/onboarding/node-and-pnpm) — JavaScript runtime and package manager. Required even if you never write code.
27+
- [ ] [GitButler](/handbook/onboarding/gitbutler) — Our git client. Visual interface instead of raw git commands.
28+
29+
**Development Tools (Engineers + Technical Roles)**
30+
31+
- [ ] [Cursor](/handbook/onboarding/cursor) — AI-powered code editor. Our primary IDE recommendation.
32+
- [ ] [Claude Code](/handbook/onboarding/claude-code) — AI coding assistant that runs in your terminal.
33+
- [ ] [Rust](https://rustup.rs) — Install via rustup. Required for building the desktop app.
34+
- [ ] [Taskfile](https://taskfile.dev/installation) — Task runner we use for dev commands.
35+
- [ ] [Docker](https://www.docker.com/products/docker-desktop/) — Required for local Supabase.
36+
37+
**Content Tools (Marketers + Content)**
38+
39+
- [ ] Cursor or any text editor — for editing MDX files
40+
- [ ] Git basics via GitButler — for pushing content changes
41+
- [ ] Admin access at `https://hyprnote.com/admin` — for media uploads and blog management
42+
43+
Verify the basics are installed:
44+
45+
```bash
46+
node --version && pnpm --version && git --version
47+
```
2348

2449
### Developer Documentation
2550

@@ -30,8 +55,9 @@ We have dedicated [developer documentation](/docs/developers/setup) covering set
3055
- [ ] GitHub org access confirmed
3156
- [ ] Slack joined, introduced yourself
3257
- [ ] Infisical access confirmed
58+
- [ ] Tools installed (work through the list above)
3359
- [ ] Read the [developer documentation](/docs/developers/setup)
34-
- [ ] Dev environment set up (IDE installed, repo cloned, builds locally)
60+
- [ ] Dev environment set up (repo cloned, builds locally)
3561
- [ ] Read this handbook — seriously, all of it
3662
- [ ] Downloaded a [staging build](/handbook/onboarding/staging-builds) and opened Hyprnote
3763

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: "Tool Setup Guides"
3+
section: "Onboarding"
4+
summary: "Step-by-step setup guides for every tool we use — written for all roles."
5+
---
6+
7+
Each guide below explains what the tool is, why we use it, and how to install it. See the [Getting Started](/handbook/onboarding/getting-started) page for the full checklist.
8+
9+
## Foundations
10+
11+
- [Homebrew](/handbook/onboarding/homebrew) — Mac package manager
12+
- [Warp](/handbook/onboarding/warp) — Terminal
13+
- [Node.js & pnpm](/handbook/onboarding/node-and-pnpm) — JavaScript runtime and package manager
14+
- [GitButler](/handbook/onboarding/gitbutler) — Git client
15+
16+
## Development
17+
18+
- [Cursor](/handbook/onboarding/cursor) — Code editor
19+
- [Claude Code](/handbook/onboarding/claude-code) — AI coding assistant
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: "Homebrew"
3+
section: "Onboarding"
4+
summary: "Install Homebrew — the Mac package manager that everything else depends on."
5+
---
6+
7+
## What It Is
8+
9+
[Homebrew](https://brew.sh) is a package manager for macOS. Think of it as an app store that runs in your terminal — you type a command, and it installs software for you. Almost every other tool in our stack is installed through Homebrew.
10+
11+
## Install
12+
13+
Open your terminal (press `Cmd + Space`, type "Terminal", hit Enter) and paste this:
14+
15+
```bash
16+
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
17+
```
18+
19+
Follow the prompts. It will ask for your Mac password — that's normal.
20+
21+
**Important:** After installation finishes, Homebrew will print a "Next steps" message with two commands to add Homebrew to your PATH. Run both of them. If you skip this, `brew` commands won't work.
22+
23+
## Verify
24+
25+
Close and reopen your terminal, then run:
26+
27+
```bash
28+
brew --version
29+
```
30+
31+
You should see something like `Homebrew 4.x.x`. If you get "command not found", you missed the PATH step above — scroll back in your terminal and run those two commands.
32+
33+
## Basics
34+
35+
```bash
36+
brew install <package> # Install something
37+
brew update # Update Homebrew itself
38+
brew upgrade # Upgrade all installed packages
39+
brew list # See what's installed
40+
```
41+
42+
You'll use `brew install` frequently during the rest of this setup.
43+
44+
## Back to Checklist
45+
46+
[Return to Tooling Checklist](/handbook/onboarding/tooling-checklist)
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
title: "Cursor"
3+
section: "Onboarding"
4+
summary: "Set up Cursor — our recommended AI-powered code editor."
5+
---
6+
7+
## What It Is
8+
9+
[Cursor](https://cursor.com) is a code editor built on VS Code with deep AI integration. It can autocomplete, refactor, explain code, and generate entire features from natural language prompts. We use it as our primary IDE.
10+
11+
Even if you're not an engineer, Cursor is useful for editing MDX content files, browsing the codebase, and making small changes.
12+
13+
## Prerequisites
14+
15+
- [Homebrew](/handbook/onboarding/homebrew) installed
16+
- [Node.js & pnpm](/handbook/onboarding/node-and-pnpm) installed (for working with the codebase)
17+
18+
## Install
19+
20+
```bash
21+
brew install --cask cursor
22+
```
23+
24+
Or download directly from [cursor.com](https://cursor.com).
25+
26+
## First Launch
27+
28+
1. Open Cursor
29+
2. Sign in with your account (free tier works, Pro is better)
30+
3. When prompted to import VS Code settings, do it if you have existing VS Code config — otherwise skip
31+
4. Open the Hyprnote repo: `File > Open Folder` and select your `hyprnote` directory
32+
33+
## Key Features to Know
34+
35+
**Cmd + K** — AI edit. Select code, press `Cmd + K`, describe what you want changed. Useful for quick edits without understanding the full syntax.
36+
37+
**Cmd + L** — AI chat. Ask questions about the codebase, get explanations, generate code.
38+
39+
**Tab completion** — Cursor predicts your next edit as you type. Press Tab to accept.
40+
41+
**Composer** (`Cmd + Shift + I`) — Multi-file AI editing. Describe a feature or change and Cursor will make edits across multiple files.
42+
43+
## Recommended Setup
44+
45+
Install the recommended extensions when Cursor prompts you. The repo includes a `.vscode/extensions.json` with our standard set.
46+
47+
## Walkthrough
48+
49+
Watch the [Cursor Visual Editor walkthrough](https://www.youtube.com/watch?v=XOtHjA8THCw) for a quick intro to the main features.
50+
51+
## For Non-Engineers
52+
53+
You don't need to understand code to use Cursor productively:
54+
55+
- **Edit MDX files** — Blog posts, docs, and handbook pages are all MDX (Markdown with some extras). Open them in Cursor, edit the text, save.
56+
- **Search the codebase**`Cmd + Shift + F` to search all files. Useful for finding where specific text appears.
57+
- **Use AI to help**`Cmd + L` and ask "explain this file" or "what does this component do" in plain English.
58+
59+
## Troubleshooting
60+
61+
**"Cursor can't connect to the network when indexing"** — Ensure you have a stable internet connection and restart Cursor.
62+
63+
**Extensions not loading** — Run `Cmd + Shift + P` > "Developer: Reload Window".
64+
65+
## Back to Checklist
66+
67+
[Return to Tooling Checklist](/handbook/onboarding/tooling-checklist)
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: "GitButler"
3+
section: "Onboarding"
4+
summary: "Set up GitButler — the visual git client we use for branching and commits."
5+
---
6+
7+
## What It Is
8+
9+
[GitButler](https://gitbutler.com) is a git client that makes branching, committing, and pushing visual and intuitive. Instead of memorizing git commands, you drag changes into branches, write commit messages, and push — all from a GUI.
10+
11+
We use GitButler for daily git workflow. You don't need to learn raw git commands to contribute at Hyprnote.
12+
13+
## Why Not Just Use Git in the Terminal?
14+
15+
You can, and some people do. But GitButler is better for most workflows because:
16+
17+
- You can see all your changes at a glance
18+
- You can organize changes into multiple branches simultaneously (virtual branches)
19+
- Committing and pushing is one click, not three commands
20+
- It handles merge conflicts visually
21+
22+
## Install
23+
24+
Download from [gitbutler.com](https://gitbutler.com) or install via Homebrew:
25+
26+
```bash
27+
brew install --cask gitbutler
28+
```
29+
30+
## First Launch
31+
32+
1. Open GitButler
33+
2. Sign in with your GitHub account
34+
3. Add the Hyprnote repo: click "Add Repository" and select your `hyprnote` folder
35+
4. GitButler will detect the existing git state and show your workspace
36+
37+
## Key Concepts
38+
39+
**Virtual Branches** — GitButler lets you have multiple branches active at the same time. Changes in your working directory can be dragged between branches. This is different from traditional git where you switch between branches.
40+
41+
**Workspace** — Your current set of active virtual branches. Everything you see in GitButler is your workspace.
42+
43+
**Commit and Push** — Select files or hunks, write a commit message, click commit. Then push to get it to GitHub.
44+
45+
## Daily Workflow
46+
47+
1. Open GitButler to see what files you've changed
48+
2. Drag changes into the right branch (or create a new one)
49+
3. Write a commit message and commit
50+
4. Push when ready for review
51+
52+
## For Non-Engineers
53+
54+
If you're editing content (blog posts, docs, handbook):
55+
56+
1. Make your edits in Cursor
57+
2. Open GitButler — your changed files will appear
58+
3. Write a short description of what you changed (e.g., "Updated blog post about product launch")
59+
4. Click commit, then push
60+
5. GitButler will create a PR on GitHub automatically if configured, or you can create one from GitHub
61+
62+
## Back to Checklist
63+
64+
[Return to Tooling Checklist](/handbook/onboarding/tooling-checklist)
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: "Claude Code"
3+
section: "Onboarding"
4+
summary: "Set up Claude Code — the AI coding assistant that runs in your terminal."
5+
---
6+
7+
## What It Is
8+
9+
[Claude Code](https://docs.anthropic.com/en/docs/claude-code) is an AI assistant that lives in your terminal. You describe what you want in plain English, and it reads files, writes code, runs commands, and makes changes across your project. Think of it as a very capable teammate you can pair-program with.
10+
11+
We use Claude Code for everything from writing features to debugging to content edits.
12+
13+
## Prerequisites
14+
15+
- [Homebrew](/handbook/onboarding/homebrew) installed
16+
- [Node.js & pnpm](/handbook/onboarding/node-and-pnpm) installed
17+
- A terminal ([Warp](/handbook/onboarding/warp) recommended)
18+
19+
## Install
20+
21+
```bash
22+
npm install -g @anthropic-ai/claude-code
23+
```
24+
25+
## First Launch
26+
27+
1. Open your terminal
28+
2. Navigate to the Hyprnote repo: `cd ~/Dev/hyprnote` (or wherever you cloned it)
29+
3. Run: `claude`
30+
4. On first launch, it will ask you to authenticate with your Anthropic account
31+
32+
## How It Works
33+
34+
Once inside a Claude Code session:
35+
36+
- **Describe what you want** — "Fix the typo in the homepage header" or "Add a new blog post template"
37+
- **It reads your codebase** — Claude Code understands the project structure and can find relevant files
38+
- **It makes changes** — You review each change before it's applied
39+
- **It runs commands** — It can run tests, builds, and other commands with your permission
40+
41+
## Useful Commands
42+
43+
```
44+
/help — See available commands
45+
/clear — Clear conversation history
46+
```
47+
48+
Type your request in natural language. Be specific about what you want — "change the button color to blue" works better than "make it look better".
49+
50+
## For Non-Engineers
51+
52+
Claude Code is powerful even if you don't write code:
53+
54+
- **Edit content** — "Update the blog post title to 'Building in Public'"
55+
- **Find things** — "Where is the pricing page defined?"
56+
- **Understand code** — "Explain what this file does"
57+
- **Make changes** — "Add a new section to the handbook about onboarding"
58+
59+
You review every change before it's applied, so you can't accidentally break anything.
60+
61+
## Back to Checklist
62+
63+
[Return to Tooling Checklist](/handbook/onboarding/tooling-checklist)
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: "Warp"
3+
section: "Onboarding"
4+
summary: "Set up Warp — a modern terminal that makes command-line work less intimidating."
5+
---
6+
7+
## What It Is
8+
9+
[Warp](https://www.warp.dev) is a modern terminal application. If you've never used a terminal before, think of it as a text-based interface to your computer — you type commands instead of clicking buttons. Warp makes this less intimidating with features like autocomplete, AI command search, and a clean interface.
10+
11+
## Why a Terminal?
12+
13+
Even non-engineers need a terminal at Hyprnote. You'll use it to:
14+
15+
- Install tools (via Homebrew)
16+
- Run the website locally to preview content changes
17+
- Use Claude Code for AI-assisted editing
18+
- Push code/content changes
19+
20+
Warp makes all of this easier than the default Mac terminal.
21+
22+
## Install
23+
24+
```bash
25+
brew install --cask warp
26+
```
27+
28+
Or download from [warp.dev](https://www.warp.dev).
29+
30+
If you don't have Homebrew yet, install Warp from the website first, then use Warp to [install Homebrew](/handbook/onboarding/homebrew).
31+
32+
## First Launch
33+
34+
1. Open Warp
35+
2. Sign in (free account)
36+
3. It will ask to be your default terminal — say yes
37+
38+
## Key Features
39+
40+
**AI Command Search** — Press `Ctrl + ~` (or click the AI icon) and describe what you want to do in plain English. Warp will suggest the right command.
41+
42+
**Autocomplete** — Start typing a command and Warp suggests completions. Press Tab to accept.
43+
44+
**Blocks** — Each command and its output is grouped into a "block". You can copy, share, or bookmark individual blocks.
45+
46+
**Workflows** — Save frequently used commands as reusable workflows.
47+
48+
## Essential Commands
49+
50+
If you're new to the terminal, here are the commands you'll use most:
51+
52+
```bash
53+
cd <folder> # Go to a folder (e.g., cd ~/Dev/hyprnote)
54+
ls # List files in the current folder
55+
pwd # Show where you are
56+
```
57+
58+
You don't need to memorize much beyond this. Use Warp's AI search for everything else, or use Claude Code which handles commands for you.
59+
60+
## macOS Permissions
61+
62+
Warp needs some system permissions to work with Hyprnote in development:
63+
64+
1. Go to **System Settings > Privacy & Security**
65+
2. Grant Warp access to **Microphone** (for testing audio features)
66+
3. Grant Warp access to **Accessibility** (for system-level features)
67+
68+
See the [developer setup docs](/docs/developers/setup) for more details on permissions.
69+
70+
## Back to Checklist
71+
72+
[Return to Tooling Checklist](/handbook/onboarding/tooling-checklist)

0 commit comments

Comments
 (0)