CLIOverview

CLI

Run the CLI with npx:

npx @internalpage/cli --help

The CLI defaults to the production API.

npx @internalpage/cli login
npx @internalpage/cli publish ./runbook.md --slug incident-runbook

login stores your personal API token in the OS config directory. Later commands reuse that token, so local scripts and AI agents do not need the token in every command.

Common commands

npx @internalpage/cli login
npx @internalpage/cli status --json
npx @internalpage/cli publish ./report.html --slug q2-report
npx @internalpage/cli publish ./runbook.md --slug incident-runbook
npx @internalpage/cli publish ./openapi.yaml --slug billing-api
npx @internalpage/cli pages --json
npx @internalpage/cli pull q2-report --output report.html
npx @internalpage/cli open q2-report

For CI or one-off commands, IP_TOKEN overrides the saved token.

publish --slug creates the page the first time and updates the same page on later runs. See Publish Pages for the full flow, AI Agents for agent workflows, and Page File Types for HTML, Markdown, and OpenAPI behavior.