{"_id":"@davivilela/discoverykit","_rev":"4-2862b67bb6708d7a16462f4dd381492c","name":"@davivilela/discoverykit","dist-tags":{"latest":"1.2.1"},"versions":{"1.0.0":{"name":"@davivilela/discoverykit","version":"1.0.0","keywords":["cursor","cursor-ai","commands","discovery","prompts","templates","cli","documentation","brownfield","codebase-analysis"],"author":{"name":"davivilela"},"license":"MIT","_id":"@davivilela/discoverykit@1.0.0","maintainers":[{"name":"davivilela","email":"davivilelaa@gmail.com"}],"homepage":"https://github.com/davivilela/discoverykit#readme","bugs":{"url":"https://github.com/davivilela/discoverykit/issues"},"bin":{"discoverykit":"cli.js"},"dist":{"shasum":"9ce14ec947953c9632a26e64728df39536d9ec7f","tarball":"https://registry.npmjs.org/@davivilela/discoverykit/-/discoverykit-1.0.0.tgz","fileCount":20,"integrity":"sha512-tJSaUJ9zoHZeg5W2A60IuFqj8wj38fScz0PfwOICFcX78nOvWAOTcffac/2bxFOLXD5dz/99f9voQCWq/wxJkQ==","signatures":[{"sig":"MEYCIQCBkgammJQBTTmZrzR+a+Q512fJqCcvsmCwiOIuEd3HsQIhAKD9hIMX649FPj9jbcJOlUl3ZX9L2OlaPAoZGv9jX3c8","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":149977},"main":"cli.js","engines":{"node":">=14.0.0"},"gitHead":"47e393a426daea0b0998341d174200ea6d04399f","scripts":{"test":"node cli.js","prepublishOnly":"echo 'Ready to publish!'"},"_npmUser":{"name":"davivilela","email":"davivilelaa@gmail.com"},"repository":{"url":"git+https://github.com/davivilela/discoverykit.git","type":"git"},"_npmVersion":"10.8.2","description":"CLI tool to install Cursor discovery prompts templates for brownfield codebase documentation","directories":{},"_nodeVersion":"20.18.0","dependencies":{"prompts":"^2.4.2"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/discoverykit_1.0.0_1759413733960_0.6900499771098498","host":"s3://npm-registry-packages-npm-production"}},"1.1.0":{"name":"@davivilela/discoverykit","version":"1.1.0","keywords":["cursor","cursor-ai","commands","discovery","prompts","templates","cli","documentation","brownfield","codebase-analysis","notion","notion-mcp","mcp","model-context-protocol"],"author":{"name":"davivilela"},"license":"MIT","_id":"@davivilela/discoverykit@1.1.0","maintainers":[{"name":"davivilela","email":"davivilelaa@gmail.com"}],"homepage":"https://github.com/davivilela/discoverykit#readme","bugs":{"url":"https://github.com/davivilela/discoverykit/issues"},"bin":{"discoverykit":"cli.js"},"dist":{"shasum":"298ffcfa483dbf488c5a1ba1c07cb14a60826efc","tarball":"https://registry.npmjs.org/@davivilela/discoverykit/-/discoverykit-1.1.0.tgz","fileCount":20,"integrity":"sha512-6nJFV1bq1aYmqIjc4D5looRbkfOJVyPdCm8AsV1XhYuybum5MVwDtYf/poDs28Ux114rfo1pjKl0uJpWF+E03g==","signatures":[{"sig":"MEUCIQCeXCqLaAih6dtdYmwgfSt+tMZsypgnZ3IQU8JQg43PGwIgeeMb5o34EnBLxbK2f4aaXGY5ShDGFVmUWcV60GbR13U=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":158344},"main":"cli.js","engines":{"node":">=14.0.0"},"gitHead":"35ea02d8a5c3b1a0d9a345070058ed75a267f15b","scripts":{"test":"node cli.js","prepublishOnly":"echo 'Ready to publish!'"},"_npmUser":{"name":"davivilela","email":"davivilelaa@gmail.com"},"repository":{"url":"git+https://github.com/davivilela/discoverykit.git","type":"git"},"_npmVersion":"10.8.2","description":"CLI tool to install Cursor discovery prompts for brownfield codebase documentation. Sync to Notion via MCP.","directories":{},"_nodeVersion":"20.18.0","dependencies":{"prompts":"^2.4.2"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/discoverykit_1.1.0_1759415345934_0.39652326770746926","host":"s3://npm-registry-packages-npm-production"}},"1.2.0":{"name":"@davivilela/discoverykit","version":"1.2.0","keywords":["cursor","cursor-ai","commands","discovery","prompts","templates","cli","documentation","brownfield","codebase-analysis","notion","notion-mcp","mcp","model-context-protocol"],"author":{"name":"davivilela"},"license":"MIT","_id":"@davivilela/discoverykit@1.2.0","maintainers":[{"name":"davivilela","email":"davivilelaa@gmail.com"}],"homepage":"https://github.com/davivilela/discoverykit#readme","bugs":{"url":"https://github.com/davivilela/discoverykit/issues"},"bin":{"discoverykit":"cli.js"},"dist":{"shasum":"2066c62b9f5973ccb9b891591c4fe43dadaade17","tarball":"https://registry.npmjs.org/@davivilela/discoverykit/-/discoverykit-1.2.0.tgz","fileCount":21,"integrity":"sha512-UZ7bY2zMzizPFDQoov/10wJPxmAe+b2u+ak9euHirZiBTuWL7IY4uGf9u5W5JdkNtVkC9zyg1pN43U1K2pDq5g==","signatures":[{"sig":"MEUCIChHUcZaHASSLZnNcUH5WAS3fUTsooS0RwadNL57egrUAiEAyjQIm3svFQqniPgt9nm9M1Ea4eep83rscDV5OLN8f7g=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":168295},"main":"cli.js","engines":{"node":">=14.0.0"},"gitHead":"6402c286ef221dba9eac78a80014f43f3e7ef3c5","scripts":{"test":"node cli.js","prepublishOnly":"echo 'Ready to publish!'"},"_npmUser":{"name":"davivilela","email":"davivilelaa@gmail.com"},"repository":{"url":"git+https://github.com/davivilela/discoverykit.git","type":"git"},"_npmVersion":"10.8.2","description":"CLI tool to install Cursor discovery prompts for brownfield codebase documentation. Sync to Notion via MCP.","directories":{},"_nodeVersion":"20.18.0","dependencies":{"prompts":"^2.4.2"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/discoverykit_1.2.0_1759419680800_0.6260642586764595","host":"s3://npm-registry-packages-npm-production"}},"1.2.1":{"name":"@davivilela/discoverykit","version":"1.2.1","description":"CLI tool to install Cursor discovery prompts for brownfield codebase documentation. Sync to Notion via MCP.","main":"cli.js","bin":{"discoverykit":"cli.js"},"scripts":{"test":"node cli.js","prepublishOnly":"echo 'Ready to publish!'"},"keywords":["cursor","cursor-ai","commands","discovery","prompts","templates","cli","documentation","brownfield","codebase-analysis","notion","notion-mcp","mcp","model-context-protocol"],"author":{"name":"davivilela"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/davivilela/discoverykit.git"},"bugs":{"url":"https://github.com/davivilela/discoverykit/issues"},"homepage":"https://github.com/davivilela/discoverykit#readme","engines":{"node":">=14.0.0"},"dependencies":{"prompts":"^2.4.2"},"_id":"@davivilela/discoverykit@1.2.1","gitHead":"322b865ac1c15d5e99ce8966850d23ad35ee3829","_nodeVersion":"20.18.0","_npmVersion":"10.8.2","dist":{"integrity":"sha512-lbDyH35eKkWqda2hPLzrfzdsEhjK7aSrDDKpoSS3cnMz3UkzqG1IBVhb23ROpn9EkNzKBUKzcaxFUw2+E6jOlw==","shasum":"7f084cdca6acc5b30362f3ed9f9659a61ce920dc","tarball":"https://registry.npmjs.org/@davivilela/discoverykit/-/discoverykit-1.2.1.tgz","fileCount":21,"unpackedSize":168839,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIE627AbU0xas1mMS+KOiULgcXXm5qXcVURazDZQ6aFAlAiBjz00Cr4hvBFuSmwSpQlWITPhy+IShYZ4zTqHri00SOg=="}]},"_npmUser":{"name":"davivilela","email":"davivilelaa@gmail.com"},"directories":{},"maintainers":[{"name":"davivilela","email":"davivilelaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/discoverykit_1.2.1_1759419915621_0.3778883337503114"},"_hasShrinkwrap":false}},"time":{"created":"2025-10-02T14:02:13.855Z","modified":"2025-10-02T15:45:15.992Z","1.0.0":"2025-10-02T14:02:14.134Z","1.1.0":"2025-10-02T14:29:06.128Z","1.2.0":"2025-10-02T15:41:21.008Z","1.2.1":"2025-10-02T15:45:15.809Z"},"bugs":{"url":"https://github.com/davivilela/discoverykit/issues"},"author":{"name":"davivilela"},"license":"MIT","homepage":"https://github.com/davivilela/discoverykit#readme","keywords":["cursor","cursor-ai","commands","discovery","prompts","templates","cli","documentation","brownfield","codebase-analysis","notion","notion-mcp","mcp","model-context-protocol"],"repository":{"type":"git","url":"git+https://github.com/davivilela/discoverykit.git"},"description":"CLI tool to install Cursor discovery prompts for brownfield codebase documentation. Sync to Notion via MCP.","maintainers":[{"name":"davivilela","email":"davivilelaa@gmail.com"}],"readme":"# DiscoveryKit\n\nA CLI tool to install Cursor discovery prompts templates into your repository. Sync results to Notion with [MCP](https://developers.notion.com/docs/mcp).\n\n## What is this?\n\nThis tool installs a comprehensive set of discovery prompts for Cursor AI, designed to help you document and understand brownfield codebases. The prompts guide you through:\n\n- Repository indexing\n- Feature inventory\n- Domain storytelling\n- Architecture analysis\n- Dependency analysis\n- C4 diagrams\n- Code quality assessment\n- Security posture\n- CI/CD pipelines\n- Data models\n- Integrations\n- Observability\n- Risks & decisions\n- Fact-checking\n\n## Installation & Usage\n\n### Quick Start - Interactive Wizard (Recommended) 🪄\n\nRun this command in your project directory:\n\n```bash\nnpx davivilela/discoverykit\n```\n\nYou'll be greeted with an interactive wizard that guides you through the installation:\n\n#### Step 1: Choose Your Action\n```\n✨ Welcome to DiscoveryKit! ✨\n\nWhat would you like to do?\n\n  1. 📦 Install all commands (recommended for first-time users)\n  2. 🎯 Custom selection (choose specific commands)\n  3. 🔗 Setup Notion MCP integration\n  4. ❌ Cancel\n```\n\n#### Step 2: Select Commands (if you chose Custom Selection)\nYou'll see a list of all 15 discovery commands with checkboxes:\n- Use **↑/↓ arrow keys** to navigate\n- Press **Space** to select/deselect commands\n- Press **Enter** to confirm your selection\n\n#### Step 3: Setup Notion MCP (if you chose Notion integration)\nThe wizard will:\n1. Configure Notion MCP in your project (`.cursor/mcp.json`)\n2. Provide next steps for authorization\n3. Optionally return to the menu to install commands\n\n💡 The MCP config is stored locally in your project and can be committed to version control for team sharing.\n\n#### Step 4: Confirm Installation\nReview your selection and confirm before installation begins.\n\n### Non-Interactive Modes\n\n**Install everything without prompts:**\n```bash\nnpx davivilela/discoverykit --all\n```\n\n**Install everything and overwrite existing files:**\n```bash\nnpx davivilela/discoverykit --all --force\n```\n\n### File Overwrite Prompts\n\nWhen a file already exists, you'll be prompted:\n```\n⚠️  File already exists: .cursor/commands/discovery/discovery-01-repo-index.md\n    Override? (y/N/yes-to-all):\n```\n\nOptions:\n- **`n`** or **`N`** (default) - Skip this file, keep the existing version\n- **`y`** or **`yes`** - Override this file with the new version\n- **`yes-to-all`** or **`a`** - Override this and all remaining files without asking again\n\n### Global Installation\n\nIf you want to use it across multiple projects:\n\n```bash\nnpm install -g davivilela/discoverykit\ndiscoverykit\n```\n\n### Command Line Options\n\n```bash\nnpx davivilela/discoverykit [options]\n```\n\n**Options:**\n- `-a, --all` - Install all commands without interactive prompts\n- `-f, --force` - Overwrite all existing files without prompting\n- `--setup-notion-mcp, --notion` - Configure Notion MCP in Cursor settings\n- `-h, --help` - Show help message\n\n**Examples:**\n```bash\n# Interactive wizard (default)\nnpx @davivilela/discoverykit\n\n# Install all commands\nnpx @davivilela/discoverykit --all\n\n# Install all, overwrite existing files\nnpx @davivilela/discoverykit --all --force\n\n# Setup Notion MCP integration\nnpx @davivilela/discoverykit --setup-notion-mcp\n\n# Show help\nnpx @davivilela/discoverykit --help\n```\n\n## Available Commands\n\nDiscoveryKit includes 15 specialized discovery prompts plus a Notion export command:\n\n| # | Command | Description |\n|---|---------|-------------|\n| 1 | **Repository Index** | Map the codebase structure and key files |\n| 2 | **Feature Inventory** | Catalog all user-facing features |\n| 3 | **Domain Storytelling** | Document business domain and workflows |\n| 4 | **Architecture Overview** | Analyze system architecture and patterns |\n| 5 | **Dependency Analysis** | Map internal and external dependencies |\n| 6 | **C4 Diagrams** | Create context and container diagrams |\n| 7 | **Code Quality Assessment** | Evaluate code health and technical debt |\n| 8 | **Security Posture** | Review security practices and vulnerabilities |\n| 9 | **CI/CD Pipelines** | Document build and deployment processes |\n| 10 | **Data Model** | Map database schemas and entities |\n| 11 | **Integrations** | Document external service integrations |\n| 12 | **Observability** | Review logging, monitoring, and alerting |\n| 13 | **Risks & Decisions** | Identify technical risks and ADRs |\n| 14 | **Fact Check** | Validate and verify discovery findings |\n| 15 | **Client Report** | Generate executive summary report |\n| 16 | **Discovery Kickoff** | Orchestration command to run all steps |\n| 17 | **Export to Notion** | Upload all discovery docs to Notion workspace |\n\n### File Structure\n\nCommands are installed to `.cursor/commands/`:\n\n```\n.cursor/\n├── mcp.json                           # Notion MCP config (if configured)\n└── commands/\n    ├── discovery-kickoff.md           # Orchestration command (runs all 14 steps)\n    ├── export-to-notion.md            # Export command (uploads to Notion)\n    └── discovery/\n        ├── discovery-01-repo-index.md\n        ├── discovery-02-feature-inventory.md\n        └── ... (all selected commands)\n```\n\n## How to Use the Discovery Prompts\n\n### Option 1: Full Discovery (Orchestrated)\n\n1. Open your project in Cursor\n2. Press `Cmd+L` (Mac) or `Ctrl+L` (Windows/Linux) to open AI chat\n3. Type `/discovery-kickoff` and press Enter\n4. The AI will run all 14 discovery steps in order and generate documentation in `/wiki/discovery/`\n\n### Option 2: Individual Steps\n\nRun specific discovery prompts as needed:\n\n1. Open Cursor AI chat (`Cmd+L` or `Ctrl+L`)\n2. Type `/` to see your commands\n3. Select the specific discovery step you want (e.g., `/discovery-04-architecture`)\n4. The AI will execute that step and create the corresponding wiki document\n\n### Option 3: Export to Notion\n\nAfter running discovery, share results with stakeholders:\n\n1. Open Cursor AI chat (`Cmd+L` or `Ctrl+L`)\n2. Type `/export-to-notion`\n3. The AI will create a Notion page hierarchy with all discovery docs\n4. Share the Notion link with your team for browsing, commenting, and linking to tasks\n\n## Output\n\nAll discovery steps generate Markdown documentation in `/wiki/discovery/` within your repository:\n\n- `/wiki/discovery/01-repo-index.md`\n- `/wiki/discovery/02-feature-inventory.md`\n- `/wiki/discovery/03-domain-storytelling.md`\n- ... and so on\n\n### 📤 Syncing to Notion\n\nYou can sync your discovery documentation to Notion using [Notion MCP](https://developers.notion.com/docs/mcp) with Cursor AI.\n\n#### Quick Setup\n\n**Option 1: Interactive Wizard**\n\nRun the CLI and select \"Setup Notion MCP integration\" from the menu:\n\n```bash\nnpx @davivilela/discoverykit\n```\n\n**Option 2: Direct Command**\n\n```bash\nnpx @davivilela/discoverykit --setup-notion-mcp\n```\n\nBoth methods will:\n- Create/update your Cursor MCP configuration at `.cursor/mcp.json` (in your project)\n- Add the Notion MCP server configuration\n- Provide next steps for authorization\n- Create a project-specific config (can be committed to git for team sharing)\n\n#### Manual Setup\n\n1. **Connect Notion to Cursor:**\n   - Open Cursor Settings (`Cmd/Ctrl + ,`)\n   - Go to **Features** → **Model Context Protocol**\n   - Click **\"Add MCP Server\"**\n   - Enter URL: `https://mcp.notion.com/mcp`\n   - Authorize your Notion workspace\n\n2. **Sync Discovery Docs:**\n   \n   After running discovery prompts, open Cursor AI (`Cmd/Ctrl + L`) and ask:\n   \n   ```\n   Please create a new Notion database called \"Codebase Discovery\" \n   and upload all the markdown files from /wiki/discovery/ as separate pages.\n   Organize them by number and maintain the formatting.\n   ```\n   \n   Or for individual files:\n   ```\n   Upload /wiki/discovery/04-architecture.md to my Notion workspace \n   as a new page in the Engineering section.\n   ```\n\n#### Benefits of Using Notion\n\n- **Collaborative editing** — Share and edit discovery docs with your team in real-time\n- **Rich formatting** — Notion's UI makes complex diagrams and tables easier to navigate\n- **Linking & references** — Connect discovery pages to related projects, tasks, and people\n- **Comments & feedback** — Team members can add questions and suggestions inline\n- **Search & organization** — Better discoverability across all your documentation\n\n#### Example Prompts for Cursor AI\n\nOnce Notion MCP is connected, you can use these prompts:\n\n```\nCreate a Notion page hierarchy for my discovery docs:\n- Parent page: \"Project Discovery - [Project Name]\"\n- Child pages for each of the 14 discovery documents\n- Add a table of contents on the parent page\n```\n\n```\nUpload the architecture and security docs to Notion \nand create a linked database to track the risks mentioned in discovery-13\n```\n\n```\nCreate a Notion dashboard that summarizes:\n- Top 5 risks from discovery-13-risks-decisions.md\n- Architecture diagram from discovery-04-architecture.md\n- Integration list from discovery-11-integrations.md\n```\n\n#### 🚀 Quick Export (One Command)\n\nWe've created a dedicated export command for you:\n\n```\n/export-to-notion\n```\n\nThis command will:\n1. Create a parent page: \"Project Discovery – {your-project-name}\"\n2. Upload all 14 discovery documents as child pages\n3. Preserve all formatting, code blocks, tables, and diagrams\n4. Add a table of contents for easy navigation\n5. Include project metadata (branch, commit, repo URL)\n\n**Example output:**\n```\n✅ Discovery Export Complete!\n\n📊 Summary:\n  • Parent page created: \"Project Discovery – MyApp\"\n  • Child pages uploaded: 14/14\n  \n🔗 Notion Link:\n  https://notion.so/Project-Discovery-MyApp-abc123\n\n📝 Now stakeholders can browse, comment, and link risks to their task tracker!\n```\n\n## Requirements\n\n- **Node.js**: 14.0.0 or higher\n- **Cursor IDE**: Latest version recommended\n- A git repository (for best results)\n\n## Updating\n\nTo get the latest version of the prompts:\n\n```bash\nnpx davivilela/discoverykit@latest\n```\n\n## Contributing\n\nIssues and pull requests are welcome!\n\n## License\n\nMIT\n\n","readmeFilename":"README.md"}