komplian
v0.8.12
Published
Komplian CLI: setup (all-in-one), onboard, Postman, localhost, mcp-tools, skills (Cursor rules), db (psql). Node 18+.
Maintainers
Readme
komplian (npm CLI)
Quickstart (práctico)
- Instala GitHub CLI,
git, Node 18+. - Login:
gh auth login -h github.com -s repo -s read:org -w - Elige flujo:
- Full (onboarding completo):
npx komplian setup - Lean (rápido para empezar a programar con IA):
npx komplian setup --lean
- Full (onboarding completo):
Qué hace cada modo
- Full (
setup):onboard → postman → mcp-tools → skills → db:all:dev → localhost - Lean (
setup --lean):onboard → skills → localhost --minimal
Arquitectura base considerada por el CLI/rules
app,web,docsen Vercelapien Google Cloud Runadminen GCP VM + Caddy + Tailscale (no Vercel)- Entornos canónicos:
productionystaging
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)
- En Postman usa una cuenta con email
@komplian.com(o añade ese email a tu perfil). - Crea una API key: Settings → API keys → Generate.
- Sincronizar (la primera vez en terminal interactiva te pide la API key y la guarda en
~/.komplian/postman-api-key; no hace faltaexportdespués):
npx komplian postman --yesOpcional: 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 this package directory (where this package.json lives), not from unrelated monorepo roots:
cd path/to/komplian-cli-package
npm login
npm publish --access publicBump 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).
