Quickstart

Publish a local file and share it as an internal page.

1. Create a personal API token

Open your internalpage workspace settings and create a personal API token. Copy the token once. Store it in a password manager or a local environment file.

2. Publish a file

IP_TOKEN=ipat_xxx \
npx @internalpage/cli pages create ./report.html --slug q2-report

You can also publish Markdown or OpenAPI:

IP_TOKEN=ipat_xxx \
npx @internalpage/cli pages create ./runbook.md --slug incident-runbook
 
IP_TOKEN=ipat_xxx \
npx @internalpage/cli pages create ./openapi.yaml --slug billing-api

The command returns a page ID and a viewer URL.

3. Update the same page

Use the page ID as the canonical update target.

IP_TOKEN=ipat_xxx \
npx @internalpage/cli pages update pg_xxx ./report.html

Slugs and shared URLs are convenient for humans, but page IDs are the stable target for automation.

Supported files

The CLI/API surface accepts .html, .htm, .md, .markdown, .yaml, .yml, and .json files. See Page File Types for rendering behavior.