Getting StartedQuickstart

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, then save it locally with the CLI.

npx @internalpage/cli login

2. Publish a file

npx @internalpage/cli publish ./report.html --slug q2-report

You can also publish Markdown or OpenAPI:

npx @internalpage/cli publish ./runbook.md --slug incident-runbook
 
npx @internalpage/cli publish ./openapi.yaml --slug billing-api

The command returns a page ID and a viewer URL.

3. Update the same page

Run the same publish command again.

npx @internalpage/cli publish ./report.html --slug q2-report

The CLI remembers the page ID in .internalpage/config.json and updates the same page on later runs.

Supported files

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