A CLI tool to convert a webpage to markdown
Project description
markitdown-cli
A lightweight CLI wrapper for Microsoft's markitdown library. Convert any webpage into a clean Markdown file directly from your terminal.
Installation
The recommended way to install markitdown-cli is using pipx:
pipx install markitdown-cli
Alternatively, you can install it with pip:
pip install markitdown-cli
Usage
The primary use case is to provide a URL to the tool. markitdown-cli will then download the page, convert it to Markdown, and save it as a file in your current directory.
Basic Usage
markitdown-cli https://example.com/article
This will create a file named article.md in the current directory.
Interactive Title Suggestion
The tool will suggest a title for the Markdown file based on the URL. You can either accept the suggestion by pressing Enter, or you can type a custom title.
$ markitdown-cli https://collabfund.com/blog/the-dumber-side-of-smart-people/
Suggested title [the-dumber-side-of-smart-people]:
Wrote: the-dumber-side-of-smart-people.md
Specifying an Output Directory
You can use the -o or --outdir option to specify a different directory to save the Markdown file.
markitdown-cli https://example.com/article -o ./my-articles
This will create article.md inside the my-articles directory.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file markitdown_cli-0.1.1.tar.gz.
File metadata
- Download URL: markitdown_cli-0.1.1.tar.gz
- Upload date:
- Size: 4.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
80c2191696868dd5cb46651db6140eab074f93b5c0e26ed87a0dce26808a6c1b
|
|
| MD5 |
b080d0d8538782db80c986e0191dcc5f
|
|
| BLAKE2b-256 |
0b5c9a1e1f910c561944f16029b7793c604102eaf40acdaa09fc190bd5fdb5b6
|
File details
Details for the file markitdown_cli-0.1.1-py3-none-any.whl.
File metadata
- Download URL: markitdown_cli-0.1.1-py3-none-any.whl
- Upload date:
- Size: 5.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
575479cbda3d804375ca4fbe9dfb9d8aa28de96d2384ff62c536a7717f759769
|
|
| MD5 |
e8e3f9e425fe9480ce546eb1612592ce
|
|
| BLAKE2b-256 |
5707b57a48adddda4698c897629ad25dc3da264f093d49d8bd24661c092ae419
|