Getting started

Get Floom working in under 3 minutes.

Install the CLI, add a shared skill without an account, publish your own Markdown skill, and give Claude or Codex one setup instruction.

1

Install the CLI

Floom starts as a terminal-native distribution layer for knowledge, instructions, and workflows.

$ npm install -g @floomhq/floom
2

Add a shared link

Anyone with the link can add the skill into their local agent setup without creating an account:

$ floom add https://floom.dev/s/ffas93ud

The skill writes to the configured local agent folder.

3

Sign in

Browser OAuth stores your Floom token locally for publishing your own skills.

$ floom login
4

Publish a skill

Two commands. floom init scaffolds a Markdown template; you edit it; floom publish uploads it.

$ floom init pr-review-brief.md # creates the file with a starter template

Open pr-review-brief.md in your editor, write the knowledge / instructions / workflow you want to share, save it, then publish:

$ floom publish pr-review-brief.md

Floom returns a shareable link like https://floom.dev/s/ffas93ud.

5

Tell your agent where Floom writes

One-time setup: paste the line below into your agent's system prompt or memory file (Claude Code: ~/.claude/CLAUDE.md, Codex: ~/.codex/AGENTS.md) so it picks up locally installed skills automatically.

Use Floom skills from ~/.claude/skills/ when they match the task.

That's it. Whenever you run floom add <link>, the skill drops into that folder and your agent finds it.

Browse skills people are sharing →

Troubleshooting

Install path looks wrong

Run floom doctor to inspect target directory and CLI compatibility.

$ floom doctor

Skill didn't appear

Check the path printed by floom add, then run floom doctor. Sign-in is only needed for publishing.

Login keeps failing

Sign out + back in: floom logout && floom login. If browser OAuth doesn't open, paste the URL it prints into your browser manually.

Still stuck

Email hello@floom.dev with the output of floom doctor attached.