servicemap
v0.1.44
Published
Generate an internal service map page or desktop app for a software project.
Maintainers
Readme
Servicemap
Reusable servicemap skill package and CLI.
The skill scans a software project for external services, resolves service logos from a bundled database, and creates either an /internalservicemap website route or a desktop app fallback.
Terminal Use
The npm package name servicemap is available, so users can run the clean command and choose where to install it:
npx servicemapThat opens the interactive install survey.
It installs to the universal .agents/skills folder and lets users choose additional agent-specific skill folders.
To install the bundled AI skill so /servicemap appears in compatible coding agents:
npx servicemap install-skillTo use an interactive Caveman-style terminal survey:
npx servicemap install-skill --surveyThat installs to the Codex-style user skill folder, matching the way Caveman installs a local skill folder. To install for several agents on the same computer:
npx servicemap install-skill --agent allThe Caveman-style command shape also works:
npx servicemap skills install --agent claudeAgents with known local skill folders get the real servicemap skill installed.
Symlink installs use a stable local clone at ~/.servicemap/source, so updates can be pulled without reinstalling every agent folder.
To update that local skill source:
npx servicemap updateRunning npx servicemap again also refreshes the stable source before installing.
After a global install, the command is:
servicemapInstall globally:
npm install -g servicemapCLI options:
servicemap
servicemap generate --root <project-path>
servicemap --root <project-path>
servicemap generate --root <project-path> --allow-emails [email protected],[email protected]
servicemap generate --root <project-path> --allow-email [email protected] --allow-email [email protected]
servicemap generate --root <project-path> --deploy
servicemap generate --root <project-path> --deploy-command "npm run deploy"
servicemap --mode page
servicemap --mode desktop
servicemap --dry-run
servicemap install-skill
servicemap install-skill --survey
servicemap install-skill --agent codex
servicemap install-skill --agent claude
servicemap install-skill --agent grok
servicemap install-skill --agent all
servicemap install-skill --targets universal,claude,grok
servicemap skills install --agent codex
servicemap updateWhen a website page is generated, Servicemap prompts before deployment when it detects a deployment command.
It prefers an existing npm run deploy script, then provider config such as Vercel or Netlify.
Use --no-deploy to skip the prompt.
Contents
servicemap/: installable skill folderbin/servicemap.mjs: npm CLI entrypointservicemap/scripts/scan-project.mjs: scans a project for service evidenceservicemap/scripts/generate-page.mjs: creates website routesservicemap/scripts/generate-desktop-app.mjs: creates the desktop fallbackservicemap/assets/service-logo-database.json: 1,000 service logo records
Validation
node bin/servicemap.mjs generate --root demo-project --allow-emails [email protected],[email protected] --dry-run
node bin/servicemap.mjs --root no-website-demo --dry-run
node bin/servicemap.mjs --dry-run
node bin/servicemap.mjs install-skill --agent all --dry-run
node bin/servicemap.mjs install-skill --targets universal,claude,grok --dry-run
node bin/servicemap.mjs skills install --agent claude --dry-run
python3 /Users/dougie/.codex/skills/.system/skill-creator/scripts/quick_validate.py servicemap