Skip to content
Cloudy docs

Getting started

Publish docs and pages from your repo with the CLI, or write them with your team in the browser.

Cloudy is a shared space for a team's docs and pages. People comment on the exact line, @mention each other, and every version is kept. Publish from your repo with the CLI, or write in the browser. The AI is optional: it builds an app from a doc when you ask for one.

Install the CLI

npm i -g usecloudy

The command is cloudy (the older name, cloudtifact, still works). The CLI needs Node.js 20 or later. To try it without installing, run npx usecloudy publish page.html.

Without npm, use the install script:

curl -fsSL https://usecloudy.ai/install.sh | sh

The script puts the CLI in ~/.cloudtifact and adds ~/.cloudtifact/bin to your PATH, so open a new terminal afterwards. cloudy upgrade updates a script install later.

Publish from your repo

cloudy login                 # opens your browser
cloudy publish page.html     # one page or folder → a link

To keep a docs folder as a space with versions:

cloudy init --dir docs       # links this repo to a space
cloudy push -m "first version"

People comment on the link, and cloudy comments hands the comments back to you or your coding agent. A public page's link opens the page itself, with a Comment button in the corner: press it, select text to quote it, and sign in (or, where the space allows guests, type your name). Add ?comments to the link to open it with the comments already showing. See the CLI reference.

Start a space in the browser

  1. Sign in on the web app and open your workspace.
  2. Press New space. It opens an untitled doc. Click the name at the top to rename it.
  3. Write. Press + next to Pages to add another doc.
  4. Press Share to invite people by email or @handle. Anyone you add to one space is a guest there and doesn't need a seat.
  5. Select text to comment on it. Comments sit on the right of the page; type @ to mention someone.

See Spaces.

Build an app

A space can hold one app built from its docs. Press + next to Pages and choose App. The app joins the list of pages, marked APP. To change it, edit the docs and press Update app. Publish gives it its own address: open to anyone with the link, behind a join code, or only for the app's owners. See Apps.

For agents

Claude Code, Codex, Cursor and GitHub Copilot get a plugin; any agent that reads skills gets the skill; ChatGPT and Claude connect through the MCP server. See Integrations.

Every page here has a Markdown version for agents: see /llms.txt. The API is described in /openapi.json.