Skip to content

Docs

Set up by asking your assistant

Paste one sentence into Claude Code, Codex, Cursor, Claude or ChatGPT, and it connects itself to Hamloy, or tells you the steps only you can do.

The quickest way to connect is to let your assistant do it. Hamloy's home page has a button, Set up with your agent, which copies one sentence. You can also type it yourself:

Read https://hamloy.com/SKILL.md and help me get started with Hamloy.

Paste it into the app you already use, in the project you work on. The assistant reads the file, works out which app it is, and does the setup for that app.

What you need

  • A Hamloy account. Create a free board first if you have none.
  • An assistant that can read a web address. Claude Code, Codex, Cursor, VS Code, Claude and ChatGPT all can.

What the assistant does

Claude Code or Codex. It runs the install line in your project's folder:

curl -fsSL https://hamloy.com/install | sh

On Windows it runs irm https://hamloy.com/install.ps1 | iex in PowerShell. This puts the hamloy program in ~/.local/bin, links the folder to a project, and sets up Claude Code and Codex for it. Your part:

  • Sign in. Your browser opens on Hamloy. Choose Allow.
  • Pick the project. The program can't ask you itself when an assistant runs it, so the assistant asks you which project, or a new name, and runs hamloy connect --project NAME.
  • Restart the assistant in that folder, so it picks up the tools. Codex then asks once to approve Hamloy's hooks with /hooks. The hooks tell Hamloy which repo, branch and files the agent touches, and bring the lists' news into the session.

Cursor or VS Code. It adds Hamloy to the project's MCP settings and keeps any servers already there. You sign in when the editor asks.

Claude or ChatGPT. They can't add a connector themselves, so they give you the steps: for Claude, Customize › Connectors › + Add › Add custom connector, with https://hamloy.com/mcp as the address. See Claude and ChatGPT for the full steps.

Any other app that speaks MCP over HTTP. It is given the address https://hamloy.com/mcp, and signs in in your browser the first time. No key is needed.

Check that it worked

Ask your assistant: "What's open in Hamloy?" It calls the list tool. On a new project the reply is short:

Pebble · 0 open, 0 done
  (nothing to show)

Then give it real work. It writes its plan into Hamloy, claims the task it starts, and puts what only you can do on Requests, with the exact steps.

S claude · ~/pebble

⏺ hamloy - Add an item (MCP)(kind: "request", title: "Make an APNs key for push reminders", body: […], needs: ["R-h2qe"])

⎿ R-p4nk@1 Make an APNs key for push reminders

⏺ Push reminders need an APNs key, and only you can make one. The steps are on your list. I'm going on with the settings screen meanwhile.

1waits on it
Make an APNs key for push reminders
Waits on you: Create the Apple Developer account and put the team id in .env as APPLE_TEAM_ID
  1. In developer.apple.com › Certificates, IDs & Profiles › Keys, press +
  2. Name it Pebble push and tick Apple Push Notifications service
  3. Download the .p8 file and put its path in .env as APNS_KEY_PATH, its id as APNS_KEY_ID

Doing this lets Push reminders at the time each habit is due go ahead.

If your project kept its open work somewhere else, such as a TODO.md or notes in the README, the assistant offers to move it into the lists.

If it doesn't work

  • "Could not resolve host" or "Could not connect to server." The assistant's sandbox has no network; Hamloy is not down. Let it run the line with network access, or run the line yourself in a terminal.
  • The sandbox stops the download or the write to ~/.local/bin. Allow it, or run the line yourself.
  • It ran in your home folder. The program installs but connects nothing. Run hamloy connect in the project's folder.
  • No tools after the restart. Run hamloy status in the folder. It shows what is set up and what is missing, with the command that fixes each.
  • You'd rather do it by hand. Every app has its own page: Claude Code, Codex, Cursor, VS Code, Claude, ChatGPT.

hamloy disconnect undoes the setup for one folder, and hamloy disconnect --all for the whole computer. Your lists stay on Hamloy.