Skip to content

Commit 69481c3

Browse files
committed
Add lazy-install path: paste-this-into-Claude prompt as the recommended onboarding
Adds PROMPT.md — a self-contained, bilingual (EN+RU) prompt the user can paste into any AI assistant (Claude Code, claude.ai, ChatGPT, Cursor, etc.). The assistant then walks them through the 8-step install/use flow as a 1-on-1 conversation, adapting to OS / shell / Python version / error messages. Why this matters: most prospective users won't read 200 lines of docs. But they will paste one block into the AI assistant they already have open. This collapses onboarding from 'find docs, scan, copy-paste, fix errors yourself' to 'paste, follow questions, done'. Prompt design notes: - Step list is explicit (not 'go read the README') so output is consistent across different AI assistants and runs - Tells the assistant NOT to execute commands, only to print and wait — important so users with sandboxed assistants don't get blocked, and for transparency - Documents common errors (PATH, missing ~/.claude/, externally-managed environments, pip not found) so the assistant fixes them quickly Each of README.md, README.ru.md, QUICKSTART.md gets a [!TIP] callout at the top pointing at PROMPT.md, framing it as the *recommended* path for 90% of users — not a workaround.
1 parent ef303bc commit 69481c3

4 files changed

Lines changed: 93 additions & 0 deletions

File tree

PROMPT.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# 🪄 The lazy install — paste this into your AI assistant
2+
3+
Most people don't read 200 lines of docs. So here's the shortest path to a working `claude-backup`:
4+
5+
1. **Open** any AI assistant — Claude Code, claude.ai, ChatGPT, Cursor's chat, anything.
6+
2. **Copy** one of the prompts below.
7+
3. **Paste** into a fresh conversation.
8+
4. **Follow** the assistant's step-by-step instructions.
9+
10+
About 5 minutes from "paste" to "your Claude Code conversations are now in clean Markdown on disk". Skip-ready, error-friendly. No need to come back to this README.
11+
12+
---
13+
14+
## English prompt
15+
16+
Copy everything between the lines:
17+
18+
---
19+
20+
```
21+
I want to install and try `claude-backup` — a CLI tool that exports my Claude Code session history to local Markdown files. The repo is https://github.com/parallelclaw/claude-backup.
22+
23+
Walk me through it step by step. After each step, wait for me to paste the output before moving on. Be terse — no walls of text, one short paragraph per step is fine. Don't run commands yourself; print the command and let me run it.
24+
25+
The full path:
26+
27+
1. Verify Python 3.9+ (`python3 --version`). If older, point me at python.org or `brew install python` (macOS) and stop here.
28+
2. Have me `git clone https://github.com/parallelclaw/claude-backup.git` somewhere convenient (default: `~/Desktop`) and `cd` into the repo.
29+
3. Have me run `pip3 install --user -e .`. If pip warns that the install dir isn't on PATH, give me the right `export PATH=...` line for my OS AND tell me how to make it permanent (in `~/.zshrc` on macOS / `~/.bashrc` on Linux).
30+
4. Have me run `claude-backup --version` to confirm the CLI is reachable.
31+
5. Have me run `claude-backup list` and help me read the table — explain what each column means (Project / Session / First Prompt or Title / Msgs / Created).
32+
6. Pick an interesting session with me and have me run `claude-backup export <8-char-prefix> --output ./backups/`. By default this writes two files: `<id>.md` (clean dialogue, only my prompts and Claude's text replies) and `<id>.full.md` (everything, including tool calls and tool results). Explain when to use each.
33+
7. Have me `open ./backups/<filename>.md` (macOS) or `xdg-open` (Linux) to view the result. Ask what I think.
34+
8. If I want a full backup of everything, have me run `claude-backup export-all --output ~/claude-backups`. Explain that the resulting folders mirror my real working directories (with the home prefix stripped).
35+
36+
If a command errors: help me debug, don't just dump a fix. Common issues —
37+
- `~/.claude/projects/` not found → I haven't used Claude Code on this machine yet
38+
- `pip: command not found` → try `python3 -m pip` instead
39+
- `command not found: claude-backup` after install → PATH issue, see step 3
40+
- "externally-managed-environment" pip error → use `pip3 install --user --break-system-packages -e .` or a venv
41+
42+
Start with step 1.
43+
```
44+
45+
---
46+
47+
## Russian prompt / Промпт на русском
48+
49+
Скопируйте всё между линиями:
50+
51+
---
52+
53+
```
54+
Я хочу установить и попробовать `claude-backup` — CLI-утилиту, которая экспортирует историю моих сессий Claude Code в локальные Markdown-файлы. Репозиторий — https://github.com/parallelclaw/claude-backup.
55+
56+
Проведи меня по шагам. После каждого шага жди когда я вставлю вывод. Будь лаконичен — никаких стен текста, один короткий абзац на шаг достаточно. Сам команды не выполняй — печатай команду и жди пока я выполню.
57+
58+
Полный путь:
59+
60+
1. Проверить Python 3.9+ (`python3 --version`). Если старее — отправь меня на python.org или скажи `brew install python` (macOS) и останови процесс.
61+
2. `git clone https://github.com/parallelclaw/claude-backup.git` куда-нибудь удобно (по умолчанию `~/Desktop`) и `cd` в репозиторий.
62+
3. `pip3 install --user -e .`. Если pip ругается что папка не в PATH — дай правильную строку `export PATH=...` для моей системы И объясни как сделать перманентным (в `~/.zshrc` на macOS / `~/.bashrc` на Linux).
63+
4. `claude-backup --version` — проверить что CLI работает.
64+
5. `claude-backup list` — помоги прочитать таблицу, объясни колонки (Project / Session / First Prompt или Title / Msgs / Created).
65+
6. Выбери со мной одну сессию и вели мне `claude-backup export <8-символьный-префикс> --output ./backups/`. По умолчанию создаются два файла: `<id>.md` (чистый диалог — только мои промпты и текстовые ответы Claude) и `<id>.full.md` (всё, включая tool-вызовы и tool-результаты). Объясни когда использовать каждый.
66+
7. `open ./backups/<filename>.md` (macOS) или `xdg-open` (Linux) — посмотреть результат. Спроси что я думаю.
67+
8. Если хочу выгрузить всё — `claude-backup export-all --output ~/claude-backups`. Объясни что папки в результате зеркалят реальные рабочие директории (с вырезанным home-префиксом).
68+
69+
Если команда выдаёт ошибку — помоги отладить, не вываливай готовый фикс. Частые проблемы:
70+
- `~/.claude/projects/` отсутствует → я ещё не пользовался Claude Code на этой машине
71+
- `pip: command not found` → попробовать `python3 -m pip`
72+
- `command not found: claude-backup` после установки → PATH, см. шаг 3
73+
- ошибка "externally-managed-environment" от pip → `pip3 install --user --break-system-packages -e .` или venv
74+
75+
Начни с шага 1.
76+
```
77+
78+
---
79+
80+
## Why this works
81+
82+
You're doing what a 1-on-1 onboarding looks like, except your assistant is the one running it. The agent adapts to your OS, your shell, your Python version, your error messages — and is patient with you. No README skim, no copy-paste confusion, no "I got an error and don't know what to do". Just one prompt and 5 minutes of guided conversation.
83+
84+
If you'd rather read: continue with [QUICKSTART.md](./QUICKSTART.md) for the manual walkthrough, or [README.md](./README.md) for the full reference.

QUICKSTART.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
> Works on **macOS**, **Linux**, and **Windows (WSL2)**. No prior experience required.
44
5+
> [!TIP]
6+
> **Even faster path:** paste [the install prompt](./PROMPT.md) into Claude (or any AI assistant) and it'll walk you through this whole guide as a conversation, adapting to your OS and any errors. Most people prefer this over reading.
7+
58
---
69

710
## What this tool does

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
55
[Русский](README.ru.md) · English
66

7+
> [!TIP]
8+
> **Don't want to read docs?** Paste [the install prompt](./PROMPT.md) into Claude (or any AI assistant) — it'll handle install + your first backup in about 5 minutes, step by step. **This is the recommended path for 90% of users.**
9+
710
---
811

912
## Why

README.ru.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
55
[English](README.md) · Русский
66

7+
> [!TIP]
8+
> **Не хотите читать доки?** Вставьте [готовый промпт](./PROMPT.md) в Claude (или любой другой AI-ассистент) — он проведёт через установку и первый бэкап за ~5 минут, по шагам. **Рекомендуемый путь для 90% пользователей.**
9+
710
---
811

912
## Зачем

0 commit comments

Comments
 (0)