komplian (npm CLI)

Developers

1. Install GitHub CLI and git (one-time per machine).
2. Browser login: gh auth login -h github.com -s repo -s read:org -w
3. npx komplian onboard --yes (sin @versión: usa latest del registry público).

Orden típico del equipo: npx komplian setup (todo en uno; formulario local en navegador si hace falta) o paso a paso: onboard → postman --yes → mcp-tools --yes → skills --yes (Cursor rules + skills) → db:all:dev → localhost --yes. Ver ONBOARDING.md.

npm ERR! ETARGET / “No matching version” (también si falló postman, no solo onboard): es el mismo paquete npm. Usa npx komplian postman --yes sin @0.4.x; comprueba npm config get registry → https://registry.npmjs.org/; npm cache clean --force. Detalle: ONBOARDING.md en el monorepo.

Postman (colección + entornos)

1. En Postman usa una cuenta con email @komplian.com (o añade ese email a tu perfil).
2. Crea una API key: Settings → API keys → Generate.
3. Sincronizar (la primera vez en terminal interactiva te pide la API key y la guarda en ~/.komplian/postman-api-key; no hace falta export después):

npx komplian postman --yes

Opcional: npx komplian postman login solo para guardar o rotar la clave sin ejecutar el sync.

Opcional: export POSTMAN_API_KEY=… solo para la sesión actual (tiene prioridad sobre el archivo).

El comando llama a GET https://api.getpostman.com/me y solo continúa si el email de la cuenta es @komplian.com. Si ya existen la colección Komplian API y los entornos con el mismo nombre en ese workspace, se actualizan; si no, se crean.

Variables de la API Komplian (apiKey, adminApiKey, workspaceId, …) se rellenan en Postman automáticamente si están en process.env o en archivos .env (busca api/.env, .env, etc.; o KOMPLIAN_DOTENV / --dotenv ruta). Nombres típicos: API_KEY, ADMIN_API_KEY, KOMPLIAN_WORKSPACE_ID. Los JSON exportados en ~/.komplian/postman-export/ (o --out) no incluyen secretos (para no commitearlos).

• Solo exportar archivos (sin subir por API): npx komplian postman --yes --export-only
• Otro workspace: POSTMAN_WORKSPACE_ID=<id>
• Ruta alternativa del archivo de clave Postman: KOMPLIAN_POSTMAN_KEY_FILE

Seguridad (CLI Postman): clave en ~/.komplian/ (permisos reforzados por el CLI), prompt sin eco, errores redactados; detalle técnico arriba. Normativa del equipo: archivo SECURITY.md en la raíz del monorepo Komplian (no va en el paquete npm).

No OAuth App registration — gh uses GitHub’s built-in flow. Default workspace: current working directory (process.cwd()), not ~/komplian. Pass a path as last argument to clone elsewhere.
Dependencies: repos with package-lock.json use npm ci (does not modify the lockfile, so no spurious git changes). Repos without a lockfile use npm install --no-package-lock so onboarding does not create a new package-lock.json. Yarn / pnpm repos use frozen lock installs when yarn / pnpm is on PATH. Unless KOMPLIAN_NPM_AUDIT=1, npm runs with --no-audit --no-fund.

Maintainers: publish from scripts/ (folder with package.json), not the monorepo root:

cd path/to/monorepo/scripts
npm login
npm publish --access public

Bump version before each publish.

If publish fails with 403 / 2FA: enable 2FA on npm (Account → Security) or use a granular token with publish rights; set NPM_TOKEN in CI (see .github/workflows/publish-komplian-npm.yml).