Skip to content

Installation

Requirements

  • Python 3.14 or later — the package uses modern typing and language features
  • uv ≥ 0.5 — recommended package manager (fast, lock-file-based)

Choose an installation mode

Mode Best for Command
uvx (ephemeral) First run, occasional conversions, no local install uvx chatgpt-to-markdown --help
uv tool install (global CLI) Frequent use with a persistent command uv tool install chatgpt-to-markdown
Development install Contributors working from source uv sync --all-groups

Run in an ephemeral environment via uvx (alias for uv tool run):

uvx chatgpt-to-markdown --help

You can run a full conversion directly:

uvx chatgpt-to-markdown ./chatgpt-export.zip ./archive

Install the CLI as a managed tool (similar to pipx):

uv tool install chatgpt-to-markdown

Then run it directly:

chatgpt-to-markdown --help

Development install (contributors)

If you are contributing code, clone the repository and install all dependency groups:

git clone https://github.com/difegam/chatgpt-to-markdown.git
cd chatgpt-to-markdown
uv sync --all-groups

For a local environment without dev/docs extras:

uv sync

Run the local checkout command with:

uv run chatgpt-to-markdown --help

Install with pip

pip install chatgpt-to-markdown

Verify the installation

If you are using uvx:

uvx chatgpt-to-markdown --help

If you installed as a tool:

chatgpt-to-markdown --help

If you are using a local development checkout:

uv run chatgpt-to-markdown --help

Expected output:

Usage: chatgpt-to-markdown [OPTIONS] INPUT_DIR OUTPUT_DIR

  Convert ChatGPT data export to offline Markdown archive.

Arguments:
  INPUT_DIR   Path to extracted ChatGPT export directory or ZIP file
  OUTPUT_DIR  Path to output Markdown archive directory

Options:
  --redact-pii / --no-redact-pii    [default: True]
  --include-thinking                [default: False]
  --deduplicate / --no-deduplicate  [default: True]
  --help                            Show this message and exit.

Install uv

If you don't have uv yet:

curl -LsSf https://astral.sh/uv/install.sh | sh

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

See the uv documentation for full installation options.

Next steps