Getting Started

Install ContextDigger and start navigating in less than 5 minutes

Install ContextDigger and start collaborating with your team in less than 5 minutes

Install ContextDigger and understand your product's architecture in less than 5 minutes

Install ContextDigger and start documenting more efficiently in less than 5 minutes

Install ContextDigger and start learning your codebase in less than 5 minutes

Install ContextDigger and get team visibility in less than 5 minutes

Installation

Important: Claude Code Required

ContextDigger works through Claude Code. All commands like /init-dig, /dig, /mark-spot, etc. are typed in your Claude Code chat session.

Future versions will support Cursor and other AI coding tools.

Requirements

  • Claude Code (Required) - The interface for all ContextDigger commands
  • 🐍
    Python 3.11 or higher - The backend engine
  • 📦
    Git - Optional, but recommended

⚡ Quick Install (Recommended)

Install or update ContextDigger with a single command:

$ curl -sSL https://contextdigger.com/install.sh | bash

This automatically installs the Python package and Claude Code skills. Works for both fresh installs and upgrades.

Alternative: Use GitHub URL directly
$ curl -sSL https://raw.githubusercontent.com/ialameh/contextdigger/main/install.sh | bash
📋 Manual Installation (Alternative)

Step 1: Install Python Package

$ pip3 install --user git+https://github.com/ialameh/contextdigger.git

Step 2: Install Claude Skills

$ curl -o - "https://raw.githubusercontent.com/ialameh/contextdigger/main/install-skills.sh" | bash

Step 3: Verify Installation

$ contextdigger --version
ContextDigger v1.0.0
$ ls ~/.claude/commands/*dig*.md | wc -l
37

🔄 Updating

Already have ContextDigger? Update to the latest version:

$ curl -sSL https://contextdigger.com/install.sh | bash

The installer automatically detects existing installations and upgrades them.

Your First Session

💬 Open Claude Code in your project directory and type these commands in the chat:

💬 Open Claude Code in your project directory and type these commands in the chat. Your team can share discoveries automatically via git:

💬 Open Claude Code in your product's codebase and type these commands to understand the architecture:

💬 Open Claude Code in the codebase you're documenting and type these commands to discover what needs documentation:

✅ Seamless Experience

Commands run instantly without interruption! ContextDigger v1.0.0 uses a CLI-based architecture that eliminates approval prompts.

Just type the command and get results immediately. No clicking "Yes", no waiting - pure productivity.

1

Initialize Your Project

$ /init-dig

Scans your project, detects languages, and discovers logical code areas automatically.

2

Dig Into an Area

$ /dig backend-api

Navigate to a specific code area and see files, history, and suggestions.

3

Mark Important Locations

$ /mark-spot auth-handler

Bookmark critical code locations for instant access later.

4

Navigate Back

$ /goto-spot auth-handler

Jump to any bookmarked location instantly, from anywhere.

Essential Commands

/init-dig

Initialize in your project

/dig <area>

Navigate to code area

/mark-spot <name>

Bookmark location

/goto-spot <name>

Jump to bookmark

/dig-dashboard

View overview

/dig-search <query>

Search everything

👥 Team Collaboration

Your team automatically shares discoveries, bookmarks, and activity through git. No setup required!

View Team Setup Guide →

👥 Working with a Team?

ContextDigger supports automatic team collaboration. See what your teammates are working on, share bookmarks, and coordinate effort.

View Team Setup Guide →

📝 Team Documentation

Coordinate documentation efforts with your team. Track which code areas have been documented and share coverage status.

View Team Setup Guide →

Next Steps