markdowntown-cli

Scan repositories for AI tool configuration files and produce JSON or Markdown audit outputs.

Updated Dec 31, 2025
One-click install
npx skills add https://github.com/joelklabo/markdowntown-cli --skill markdowntown-cli
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: markdowntown-cli
Source: https://github.com/joelklabo/markdowntown-cli/tree/main/codex/skills/markdowntown-cli
Command: npx skills add https://github.com/joelklabo/markdowntown-cli --skill markdowntown-cli

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provides a clear, deterministic workflow for building, testing, and scanning the markdowntown CLI so developers can produce evidence-backed audit outputs and safe repository handoffs without ad-hoc or destructive changes.

Core Features & Use Cases

  • Deterministic Scanning: Run repository scans that prefer ripgrep for consistent results and produce compact JSON or Markdown outputs for audit and suggestions.
  • Developer Workflow Enforcement: Build the CLI, run lint and tests, and require CI to be green before merging; avoid destructive git commands unless explicitly requested.
  • Integration & Handoffs: Generate Workbench handoff links for snapshots, follow apps/web guidance for web changes, and consult CLI-specific model guidance in cli/CLAUDE.md and cli/GEMINI.md.
  • Use Case: A maintainer needs to run a reproducible scan, validate lint/tests locally, and create a Workbench snapshot to export a patch back to the CLI with minimal, reviewable changes.

Quick Start

Run the markdowntown CLI to scan the repository, run lint and tests, and generate a compact JSON audit for review.

Frequently Asked Questions about markdowntown-cli

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I scan a repository to detect AI tool configuration files?

Repository scanning detects AI tool configuration files by running deterministic searches that prefer ripgrep, producing compact JSON or Markdown audit outputs. This ensures consistent, evidence-backed results for review and CI validation.

What is a deterministic CLI audit output for repository snapshots?

A deterministic CLI audit output is a compact JSON or Markdown file generated by scanning repositories for configuration files. It provides evidence-backed results that ensure reproducible repository snapshots and safe Workbench handoffs.

How do I run lint and tests before generating a repository audit?

Run lint and tests by building the CLI from the cli directory and executing make lint and make test. CI must be green before merging to ensure the repository scan produces a valid, evidence-backed audit.

Can I use ripgrep for consistent repository scanning results?

Yes, ripgrep is explicitly preferred for repository scanning to deliver deterministic, consistent results. It integrates directly into the CLI workflow to detect AI tool configuration files and generate compact audit outputs.

How do I create a Workbench handoff link after a repository scan?

Generate Workbench handoff links for snapshots after completing the repository scan and producing the audit output. This enables exporting reviewable patches back to the CLI with minimal, non-destructive changes.

Why should I avoid destructive git commands during repository scanning?

Avoid destructive git commands during repository scanning to prevent unintended data loss and maintain deterministic audit outputs. Destructive commands should only be used when explicitly requested by the developer.