Skip to main content

Getting Started

This guide will help you install Project Mapper and generate your first knowledge transfer document.

Installation​

You have two options for using Project Mapper:

Install Globally​

Install Project Mapper globally to use it across all your projects:

npm install -g project-mapper

Once installed globally, you can run it using the project-mapper command.

Use with npx (No Installation)​

Alternatively, you can use Project Mapper without installation using npx:

npx project-mapper

Quick Start​

Generate a project summary in three simple steps:

# 1. Navigate to your project directory
cd your-project-directory

# 2. Generate a knowledge transfer document
project-mapper

# 3. Share the generated document with your LLM
# The summary will be saved as project-knowledge-transfer.md

Basic Usage​

Analyze Current Directory​

By default, Project Mapper analyzes the current directory:

project-mapper

Analyze a Specific Directory​

You can specify a different directory to analyze:

project-mapper /path/to/your/project

Specify Output File​

Change the output file name and location:

project-mapper -o custom-summary.md

Next Steps​

After generating your first knowledge transfer document, check out: