Skip to content

README: install with Claude Code (copy-paste prompt) - #27

Merged
sathyaprakash000 merged 1 commit into
mainfrom
claude/readme-claude-code-prompt
Oct 26, 2026
Merged

sathyaprakash000 merged 1 commit into
mainfrom
claude/readme-claude-code-prompt

Conversation

@sathyaprakash000

Copy link
Copy Markdown
Contributor

Adds "Rather have Claude Code do it?" to the README's Quick start, right after the one-command install: a prompt you paste into Claude Code running on the server. GitHub shows a copy button on the block.

What the prompt makes Claude do:

  1. Check prerequisites (Docker + Compose v2, disk).
  2. Pick the route from the server's actual state: DNS → this IP and 80/443 free → --domain; 80/443 held by an existing proxy → --url + a free port, routing only this domain in that proxy, with the overlay in COMPOSE_FILE inside .env; DNS not pointing here → stop and say which record to create; no domain → plain IP. It explains the choice before running anything.
  3. Run the pinned v3.1.1 one-liner.
  4. Verify outcomes, not steps: / must return 200 and /api/auth/me must return {"error":"Unauthorized"}. Any ! warning gets diagnosed from the caddy/backend logs before reporting done.
  5. Report the URL and sign-in, and tell the user which .env secrets to store off the server.

Guard rails in the prompt: never edit or regenerate .env secrets, never docker compose down -v, don't touch other containers or sites, start/stop only via up.sh / down.sh.

The version appears as v3.1.1 like the other README pins, so the usual release bump updates it too.

Not tested by running it through Claude Code end to end; every command it uses is the one already tested for the 3.1.0/3.1.1 releases.

🤖 Generated with Claude Code

Many people now deploy by asking Claude Code on the server rather than
typing commands. The prompt walks it through the same pinned installer:
check DNS and ports, pick --domain / --url behind an existing proxy / a
plain IP, verify the site and API, and report the sign-in, with rules
that keep it away from other services and the .env secrets.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@sathyaprakash000
sathyaprakash000 merged commit ec03a0f into main Oct 26, 2026
8 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants