@foxden-app/foxclaw 0.2.6 → 0.3.0

package/docs/agent-assisted-install.md

@@ -1,84 +1,84 @@
-# Agent-Assisted Install
-
-If you already have a shell-capable coding agent on the target computer, use this path first. It is the fastest and least error-prone way to install FoxClaw.
-
-This works well with Codex, OpenClaw, QwenPaw, Hermes, OpenCode, Kimi CLI, or any agent that can inspect the machine, run shell commands, edit files, and report blockers.
-
-## What You Need To Provide
-
-Prepare these values before asking the agent:
-
-- `TG_BOT_TOKEN`: Telegram bot token from `@BotFather`
-- `TG_ALLOWED_USER_ID`: your numeric Telegram user id
-- `DEFAULT_CWD`: the folder where Codex should work
-
-Optional later:
-
-- `TG_ALLOWED_CHAT_ID`
-- `TG_ALLOWED_TOPIC_ID`
-
-Use private Telegram chat first. Configure groups/topics only after private chat works.
-
-## Copy-Paste Prompt
-
-Send this to your agent on the target computer:
-
-```text
-Install FoxClaw on this machine.
-
-Repository:
-Published package:
-@foxden-app/foxclaw
-
-Use private Telegram chat first. Do not configure group/topic mode unless I explicitly provide TG_ALLOWED_CHAT_ID or TG_ALLOWED_TOPIC_ID.
-
-Here are the required values:
-TG_BOT_TOKEN=<paste token here>
-TG_ALLOWED_USER_ID=<paste numeric Telegram user id here>
-DEFAULT_CWD=<paste absolute working directory here>
-
-Tasks:
-1. Inspect the machine first. If a FoxClaw or old telegram-codex-app-bridge service already exists, report it before changing services.
-2. Ensure Node.js 24+ is available. If not, install or activate Node 24 with nvm.
-3. Ensure the Codex CLI exists and is logged in. If login is required, stop and tell me exactly what I need to do.
-4. Install or update FoxClaw with npm install -g @foxden-app/foxclaw@latest.
-5. Run foxclaw init, then write ~/.foxclaw/.env. Never print or commit the bot token.
-6. Run foxclaw doctor.
-7. Start FoxClaw with foxclaw start.
-8. Ask me to send /help and /status to the Telegram bot.
-9. Verify the final state:
-   - foxclaw.service is active/enabled on Linux
-   - old telegram-codex-app-bridge.service is inactive/disabled if present
-   - foxclaw status works
-10. Report the commands used, the final status, and the log command I should use if something stops working. Redact TG_BOT_TOKEN and never print the full token or full .env content.
-```
-
-## Migration Prompt For Old Installs
-
-Use this when the target computer is still running `telegram-codex-app-bridge`:
-
-```text
-Migrate this machine from telegram-codex-app-bridge to FoxClaw.
-
-New package:
-@foxden-app/foxclaw
-
-Please:
-1. Inspect the current install method, service file, and runtime directory before changing anything.
-2. Stop and disable telegram-codex-app-bridge.service if it exists.
-3. If ~/.foxclaw does not exist and ~/.telegram-codex-app-bridge exists, copy ~/.telegram-codex-app-bridge to ~/.foxclaw.
-4. Install or update FoxClaw with npm install -g @foxden-app/foxclaw@latest.
-5. Run foxclaw init if ~/.foxclaw/.env does not exist, then verify ~/.foxclaw/.env.
-6. Run foxclaw doctor.
-7. Install or restart the FoxClaw service with foxclaw start.
-8. Verify foxclaw.service is active and telegram-codex-app-bridge.service is inactive/disabled.
-9. Report final status and any blockers. Redact TG_BOT_TOKEN and never print the full token or full .env content.
-```
-
-## Safety Notes
-
-- Do not paste bot tokens into public issue trackers or public chat logs.
-- Do not commit `.env`.
-- When reporting results, redact `TG_BOT_TOKEN`.
-- Do not use `/` or your whole home directory as `DEFAULT_CWD` for a first install.
-- Use `foxclaw start` for normal service startup. Use foreground `foxclaw serve` only when troubleshooting.
+# Agent-Assisted Install
+
+If you already have a shell-capable coding agent on the target computer, use this path first. It is the fastest and least error-prone way to install FoxClaw.
+
+This works well with Codex, OpenClaw, QwenPaw, Hermes, OpenCode, Kimi CLI, or any agent that can inspect the machine, run shell commands, edit files, and report blockers.
+
+## What You Need To Provide
+
+Prepare these values before asking the agent:
+
+- `TG_BOT_TOKEN`: Telegram bot token from `@BotFather`
+- `TG_ALLOWED_USER_ID`: your numeric Telegram user id
+- `DEFAULT_CWD`: the folder where Codex should work
+
+Optional later:
+
+- `TG_ALLOWED_CHAT_ID`
+- `TG_ALLOWED_TOPIC_ID`
+
+Use private Telegram chat first. Configure groups/topics only after private chat works.
+
+## Copy-Paste Prompt
+
+Send this to your agent on the target computer:
+
+```text
+Install FoxClaw on this machine.
+
+Repository:
+Published package:
+@foxden-app/foxclaw
+
+Use private Telegram chat first. Do not configure group/topic mode unless I explicitly provide TG_ALLOWED_CHAT_ID or TG_ALLOWED_TOPIC_ID.
+
+Here are the required values:
+TG_BOT_TOKEN=<paste token here>
+TG_ALLOWED_USER_ID=<paste numeric Telegram user id here>
+DEFAULT_CWD=<paste absolute working directory here>
+
+Tasks:
+1. Inspect the machine first. If a FoxClaw or old telegram-codex-app-bridge service already exists, report it before changing services.
+2. Ensure Node.js 24+ is available. If not, install or activate Node 24 with nvm.
+3. Ensure the Codex CLI exists and is logged in. If login is required, stop and tell me exactly what I need to do.
+4. Install or update FoxClaw with npm install -g @foxden-app/foxclaw@latest.
+5. Run foxclaw init, then write ~/.foxclaw/.env. Never print or commit the bot token.
+6. Run foxclaw doctor.
+7. Start FoxClaw with foxclaw start.
+8. Ask me to send /help and /status to the Telegram bot.
+9. Verify the final state:
+   - foxclaw.service is active/enabled on Linux
+   - old telegram-codex-app-bridge.service is inactive/disabled if present
+   - foxclaw status works
+10. Report the commands used, the final status, and the log command I should use if something stops working. Redact TG_BOT_TOKEN and never print the full token or full .env content.
+```
+
+## Migration Prompt For Old Installs
+
+Use this when the target computer is still running `telegram-codex-app-bridge`:
+
+```text
+Migrate this machine from telegram-codex-app-bridge to FoxClaw.
+
+New package:
+@foxden-app/foxclaw
+
+Please:
+1. Inspect the current install method, service file, and runtime directory before changing anything.
+2. Stop and disable telegram-codex-app-bridge.service if it exists.
+3. If ~/.foxclaw does not exist and ~/.telegram-codex-app-bridge exists, copy ~/.telegram-codex-app-bridge to ~/.foxclaw.
+4. Install or update FoxClaw with npm install -g @foxden-app/foxclaw@latest.
+5. Run foxclaw init if ~/.foxclaw/.env does not exist, then verify ~/.foxclaw/.env.
+6. Run foxclaw doctor.
+7. Install or restart the FoxClaw service with foxclaw start.
+8. Verify foxclaw.service is active and telegram-codex-app-bridge.service is inactive/disabled.
+9. Report final status and any blockers. Redact TG_BOT_TOKEN and never print the full token or full .env content.
+```
+
+## Safety Notes
+
+- Do not paste bot tokens into public issue trackers or public chat logs.
+- Do not commit `.env`.
+- When reporting results, redact `TG_BOT_TOKEN`.
+- Do not use `/` or your whole home directory as `DEFAULT_CWD` for a first install.
+- Use `foxclaw start` for normal service startup. Use foreground `foxclaw serve` only when troubleshooting.