@payme-io/docs-cli

CLI for the PayMe documentation platform. Designed for CI/CD pipelines, usable by humans with a personal API key.

Install

npm install -g @payme-io/docs-cli

Requires Node 18+.

First time setup — humans

payme-docs login
# paste your key when prompted

The key is stored at ~/.payme-docs/config.json (mode 0600).

CI/CD usage

Set an environment variable in your pipeline secrets — no login step required:

# GitHub Actions example
env:
  PAYME_DOCS_API_KEY: ${{ secrets.PAYME_DOCS_API_KEY }}

steps:
  - run: npx -p @payme-io/docs-cli payme-docs projects list

Commands

payme-docs login                Save and verify an API key.
payme-docs logout               Remove the locally stored key.
payme-docs whoami               Show identity the server sees.
payme-docs projects list        List visible projects.

All commands accept --server <url> to override the default server, and --json for machine-readable output.

Getting a key

Admins generate API keys in the web UI at /admin/api-keys. The full key is shown once at creation — copy it immediately into your password manager or CI secret store.

Environment variables

| Variable | Purpose | |---|---| | PAYME_DOCS_API_KEY | API key. Overrides ~/.payme-docs/config.json. | | PAYME_DOCS_URL | Server URL. Defaults to https://amit.pm-tools.dev. |

Exit codes

• 0 — success
• non-zero — any failure (invalid key, network error, validation, etc.). Pipelines fail correctly.