Get started

Pageship lets your agent turn a document request into a published link. You ask your agent for a report, plan or spec. The agent writes it as an HTML file and, when you ask, publishes it with the Pageship CLI and gives you the link.

Each document stays at the same link when it changes. New documents are private until you choose to make them public.

The fastest path

Give your agent the setup guide:

Set up Pageship. Download https://pageship.dev/setup-guide.md with curl or a similar command, read all of it, and follow it.

The agent checks what you already have, then asks you once before it changes anything. It installs the CLI and the Pageship skills, and offers two optional skills that improve the look of documents. Then it signs you in. You approve the sign-in in your browser. See the setup guide for every step.

You can also do each step yourself, as below.

Manual install

The CLI needs Node.js 24.11 or newer. Install it globally with your package manager:

npm i -g pageship
pnpm add -g pageship
bun add -g pageship

Then check that your shell finds it:

pageship --version

To run a command without installing the CLI, put npx in front of it:

npx pageship status

Sign in

Run:

pageship login

Open the link it shows, on any machine, and approve the code with your invited GitHub account.

After you approve, login keeps your existing workspace address, or claims your GitHub login as the address. If that name is reserved or taken, the terminal lets you pick a generated address instead. Your personal documents get links on that address, such as https://<workspace>.pageship.dev/d/<id>-<slug>.

Install the skills

The skills teach your agent to write documents and to publish them. They ship inside the CLI. Install them with:

pageship skills install

This puts them in ~/.agents/skills, and links them into ~/.claude/skills for Claude Code when ~/.claude exists. Pageship skills explains what each one does.

You may need to start a new agent session before your agent loads the new skills.

Check that you are ready

Run:

pageship status

It reports whether you are signed in, whether your workspace address is set, and whether the skills are installed and current. It only reads. It never signs you in or uploads anything.

Ask for a document

Now ask your agent for something, in your own words:

Write a report comparing these three approaches, with a recommendation, and publish it.

The first time, the agent may ask whether you want documents as HTML or Markdown, and whether to save that choice. Pageship publishes HTML, so this example assumes HTML. A Markdown document stays a local file. The agent writes the document as an HTML file in your project. It publishes only when you ask, in the same request or after it offers. It then gives you the link and says that the document is private.

Later changes in the same conversation publish to the same link without asking again:

Add a cost breakdown and expand the risks.

To let other people read it, ask the agent to make it public. Anyone with the link can then read it without signing in. To share it with only some people, keep it private and add them as viewers by their GitHub username; see Share a document.

Next

• Share a document: make a document public, or share it with named GitHub users.
• Pageship skills: what the skills do, and how to update or remove them.
• CLI reference: every command, its options and its results, including publishing and managing documents.