agentleFS
shivasaini04shivasaini04/nanocrew/.claude/skills/setup/SKILL.md

setup

Skill4 starsChanged 29 days agoMITView on GitHub

Run initial NanoCrew setup. Use when user wants to install dependencies, authenticate WhatsApp, register their main channel, or start the background services. Triggers on "setup", "install", "configure NanoCrew", or first-time setup requests.

  • Pipes a download into a shell
  • Reads credentials
  • Installs packages

192 other projects use a version of this, 2 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use add-atomic-chat-tool, add-dashboard and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • MicrosoftSkill

    add-atomic-chat-tool

    Add Atomic Chat MCP server so the container agent can call local models served by the Atomic Chat desktop app via its OpenAI-compatible API.

    Also in 8 projects that use this

  • MicrosoftSkill

    add-dashboard

    Add a monitoring dashboard to NanoClaw. Installs @nanoco/nanoclaw-dashboard and a pusher that sends periodic JSON snapshots.

    Also in 8 projects that use this

  • +10 more from microsoft

The file

Show its rules and text

We split this skill into the rules it gives an agent

21 rules. 0 are common, 1 is distinctive, and 20 are very specific to this project.

  • 0

    Common

    Most of the 169 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 20

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Run setup steps automatically.

    line 8
  2. Very specific:

    UX Note: Use AskUserQuestion for all user-facing questions.

    line 12
  3. Very specific:

    Run bash setup.sh and parse the status block.

    line 16
  4. Very specific:

    If NODE_OK=false → Node.js is missing or too old.

    line 18
  5. Very specific:

    After installing Node, re-run bash setup.sh

    line 21
  6. Very specific:

    If DEPS_OK=false → Read logs/setup.log.

    line 22
  7. Very specific:

    If NATIVE_OK=false → better-sqlite3 failed to load.

    line 23
  8. Very specific:

    If HAS_AUTH=true → note that WhatsApp auth exists, offer to skip step 5

    line 30
  9. Very specific:

    If HAS_REGISTERED_GROUPS=true → note existing config, offer to skip or reconfigure

    line 31
  10. Very specific:

    Check the preflight results for APPLE_CONTAINER and DOCKER, and the PLATFORM from step 1.

    line 38
  11. Very specific:

    If BUILD_OK=false: Read logs/setup.log tail for the build error.

    line 54
  12. Very specific:

    If HAS_ENV=true from step 2, read .env and check for CLAUDE_CODE_OAUTH_TOKEN or ANTHROPIC_API_KEY.

    line 62
  13. Very specific:

    If HAS_AUTH=true, confirm: keep or re-authenticate?

    line 72
  14. Very specific:

    If IS_HEADLESS=true AND IS_WSL=false → AskUserQuestion: Pairing code (recommended) vs QR code in terminal?

    line 76
  15. Very specific:

    Pairing code: Ask for phone number first.

    line 80
  16. Very specific:

    DM with bot: Ask for bot's number, JID = NUMBER@s.whatsapp.net

    line 97
  17. Very specific:

    Run npx tsx setup/index.ts --step register -- --jid "JID" --name "main" --trigger "@TriggerWord" --folder "main" plus --no-trigger-required …

    line 107
  18. Distinctive:

    If service already running: unload first.

    line 118
  19. Very specific:

    Read logs/setup.log for the error.

    line 141
  20. Very specific:

    Service not starting: Check logs/NanoCrew.error.log.

    line 162
  21. Very specific:

    No response to messages: Check trigger pattern. Main channel doesn't need prefix.

    line 166

“Common” is measured: kept by at least 6 in 10 of the 169 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

NanoCrew Setup

Run setup steps automatically. Only pause when user action is required (WhatsApp authentication, configuration choices). Setup uses bash setup.sh for bootstrap, then npx tsx setup/index.ts --step <name> for all other steps. Steps emit structured status blocks to stdout. Verbose logs go to logs/setup.log.

Principle: When something is broken or missing, fix it. Don't tell the user to go fix it themselves unless it genuinely requires their manual action (e.g. scanning a QR code, pasting a secret token). If a dependency is missing, install it. If a service won't start, diagnose and repair. Ask the user for permission when needed, then do the work.

UX Note: Use AskUserQuestion for all user-facing questions.

1. Bootstrap (Node.js + Dependencies)

Run bash setup.sh and parse the status block.

  • If NODE_OK=false → Node.js is missing or too old. Use AskUserQuestion: Would you like me to install Node.js 22? If confirmed:
    • macOS: brew install node@22 (if brew available) or install nvm then nvm install 22
    • Linux: curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash - && sudo apt-get install -y nodejs, or nvm
    • After installing Node, re-run bash setup.sh
  • If DEPS_OK=false → Read logs/setup.log. Try: delete node_modules and package-lock.json, re-run bash setup.sh. If native module build fails, install build tools (xcode-select --install on macOS, build-essential on Linux), then retry.
  • If NATIVE_OK=false → better-sqlite3 failed to load. Install build tools and re-run.
  • Record PLATFORM and IS_WSL for later steps.

2. Check Environment

Run npx tsx setup/index.ts --step environment and parse the status block.

  • If HAS_AUTH=true → note that WhatsApp auth exists, offer to skip step 5
  • If HAS_REGISTERED_GROUPS=true → note existing config, offer to skip or reconfigure
  • Record APPLE_CONTAINER and DOCKER values for step 3

3. Container Runtime

3a. Choose runtime

Check the preflight results for APPLE_CONTAINER and DOCKER, and the PLATFORM from step 1.

Docker is the supported runtime on every platform. Continue to 3a-docker.

3a-docker. Install Docker

  • DOCKER=running → continue to 3b
  • DOCKER=installed_not_running → start Docker: open -a Docker (macOS) or sudo systemctl start docker (Linux). Wait 15s, re-check with docker info.
  • DOCKER=not_found → Use AskUserQuestion: Docker is required for running agents. Would you like me to install it? If confirmed:
    • macOS: install via brew install --cask docker, then open -a Docker and wait for it to start. If brew not available, direct to Docker Desktop download at https://docker.com/products/docker-desktop
    • Linux: install with curl -fsSL https://get.docker.com | sh && sudo usermod -aG docker $USER. Note: user may need to log out/in for group membership.

3c. Build and test

Run npx tsx setup/index.ts --step container -- --runtime <chosen> and parse the status block.

If BUILD_OK=false: Read logs/setup.log tail for the build error.

  • Cache issue (stale layers): docker builder prune -f (Docker) or container builder stop && container builder rm && container builder start (Apple Container). Retry.
  • Dockerfile syntax or missing files: diagnose from the log and fix, then retry.

If TEST_OK=false but BUILD_OK=true: The image built but won't run. Check logs — common cause is runtime not fully started. Wait a moment and retry the test.

4. Claude Authentication (No Script)

If HAS_ENV=true from step 2, read .env and check for CLAUDE_CODE_OAUTH_TOKEN or ANTHROPIC_API_KEY. If present, confirm with user: keep or reconfigure?

AskUserQuestion: Claude subscription (Pro/Max) vs Anthropic API key?

Subscription: Tell user to run claude setup-token in another terminal, copy the token, add CLAUDE_CODE_OAUTH_TOKEN=<token> to .env. Do NOT collect the token in chat.

API key: Tell user to add ANTHROPIC_API_KEY=<key> to .env.

5. WhatsApp Authentication

If HAS_AUTH=true, confirm: keep or re-authenticate?

Choose auth method based on environment (from step 2):

If IS_HEADLESS=true AND IS_WSL=false → AskUserQuestion: Pairing code (recommended) vs QR code in terminal? Otherwise (macOS, desktop Linux, or WSL) → AskUserQuestion: QR code in browser (recommended) vs pairing code vs QR code in terminal?

  • QR browser: npx tsx setup/index.ts --step whatsapp-auth -- --method qr-browser (Bash timeout: 150000ms)
  • Pairing code: Ask for phone number first. npx tsx setup/index.ts --step whatsapp-auth -- --method pairing-code --phone NUMBER (Bash timeout: 150000ms). Display PAIRING_CODE.
  • QR terminal: npx tsx setup/index.ts --step whatsapp-auth -- --method qr-terminal. Tell user to run npm run auth in another terminal.

If failed: qr_timeout → re-run. logged_out → delete store/auth/ and re-run. 515 → re-run. timeout → ask user, offer retry.

6. Configure Trigger and Channel Type

Get bot's WhatsApp number: node -e "const c=require('./store/auth/creds.json');console.log(c.me.id.split(':')[0].split('@')[0])"

AskUserQuestion: Shared number or dedicated? → AskUserQuestion: Trigger word? → AskUserQuestion: Main channel type?

Shared number: Self-chat (recommended) or Solo group Dedicated number: DM with bot (recommended) or Solo group with bot

7. Sync and Select Group (If Group Channel)

Personal chat: JID = NUMBER@s.whatsapp.net DM with bot: Ask for bot's number, JID = NUMBER@s.whatsapp.net

Group:

  1. npx tsx setup/index.ts --step groups (Bash timeout: 60000ms)
  2. BUILD=failed → fix TypeScript, re-run. GROUPS_IN_DB=0 → check logs.
  3. npx tsx setup/index.ts --step groups -- --list for pipe-separated JID|name lines.
  4. Present candidates as AskUserQuestion (names only, not JIDs).

8. Register Channel

Run npx tsx setup/index.ts --step register -- --jid "JID" --name "main" --trigger "@TriggerWord" --folder "main" plus --no-trigger-required if personal/DM/solo, --assistant-name "Name" if not Nano.

9. Mount Allowlist

AskUserQuestion: Agent access to external directories?

No: npx tsx setup/index.ts --step mounts -- --empty Yes: Collect paths/permissions. npx tsx setup/index.ts --step mounts -- --json '{"allowedRoots":[...],"blockedPatterns":[],"nonMainReadOnly":true}'

10. Start Service

If service already running: unload first.

  • macOS: launchctl unload ~/Library/LaunchAgents/com.NanoCrew.plist
  • Linux: systemctl --user stop NanoCrew (or systemctl stop NanoCrew if root)

Run npx tsx setup/index.ts --step service and parse the status block.

If FALLBACK=wsl_no_systemd: WSL without systemd detected. Tell user they can either enable systemd in WSL (echo -e "[boot]\nsystemd=true" | sudo tee /etc/wsl.conf then restart WSL) or use the generated start-NanoCrew.sh wrapper.

If DOCKER_GROUP_STALE=true: The user was added to the docker group after their session started — the systemd service can't reach the Docker socket. Ask user to run these two commands:

  1. Immediate fix: sudo setfacl -m u:$(whoami):rw /var/run/docker.sock
  2. Persistent fix (re-applies after every Docker restart):
sudo mkdir -p /etc/systemd/system/docker.service.d
sudo tee /etc/systemd/system/docker.service.d/socket-acl.conf << 'EOF'
[Service]
ExecStartPost=/usr/bin/setfacl -m u:USERNAME:rw /var/run/docker.sock
EOF
sudo systemctl daemon-reload

Replace USERNAME with the actual username (from whoami). Run the two sudo commands separately — the tee heredoc first, then daemon-reload. After user confirms setfacl ran, re-run the service step.

If SERVICE_LOADED=false:

  • Read logs/setup.log for the error.
  • macOS: check launchctl list | grep NanoCrew. If PID=- and status non-zero, read logs/NanoCrew.error.log.
  • Linux: check systemctl --user status NanoCrew.
  • Re-run the service step after fixing.

11. Verify

Run npx tsx setup/index.ts --step verify and parse the status block.

If STATUS=failed, fix each:

  • SERVICE=stopped → npm run build, then restart: launchctl kickstart -k gui/$(id -u)/com.NanoCrew (macOS) or systemctl --user restart NanoCrew (Linux) or bash start-NanoCrew.sh (WSL nohup)
  • SERVICE=not_found → re-run step 10
  • CREDENTIALS=missing → re-run step 4
  • WHATSAPP_AUTH=not_found → re-run step 5
  • REGISTERED_GROUPS=0 → re-run steps 7-8
  • MOUNT_ALLOWLIST=missing → npx tsx setup/index.ts --step mounts -- --empty

Tell user to test: send a message in their registered chat. Show: tail -f logs/NanoCrew.log

Troubleshooting

Service not starting: Check logs/NanoCrew.error.log. Common: wrong Node path (re-run step 10), missing .env (step 4), missing auth (step 5).

Container agent fails ("Claude Code process exited with code 1"): Ensure the container runtime is running — open -a Docker (macOS Docker), container system start (Apple Container), or sudo systemctl start docker (Linux). Check container logs in groups/main/logs/container-*.log.

No response to messages: Check trigger pattern. Main channel doesn't need prefix. Check DB: npx tsx setup/index.ts --step verify. Check logs/NanoCrew.log.

WhatsApp disconnected: npm run auth then rebuild and restart: npm run build && launchctl kickstart -k gui/$(id -u)/com.NanoCrew (macOS) or systemctl --user restart NanoCrew (Linux).

Unload service: macOS: launchctl unload ~/Library/LaunchAgents/com.NanoCrew.plist | Linux: systemctl --user stop NanoCrew

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.