Getting started

Get Floom V1 Preview 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

Write knowledge, instructions, or a workflow in Markdown, then publish it as a skill.

$ floom init pr-review-brief.md
$ floom publish pr-review-brief.md

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

5

Tell Claude or Codex where Floom writes skills

Add this to your agent instructions so locally installed skills get used when they fit the task:

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

MCP sync is Version 1 preview. floom add is the stable install path for shared links.

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.