mdlm
mdlm is a governance-focused CLI tool for your markdownlm knowledge base. It bridges the gap between your codebase and your team's architectural standards by providing a powerful toolkit for syncing documentation, querying patterns, and validating code against established rules.
Built for consistency, mdlm allows you to enforce design patterns, surface documentation gaps, and ensure that your architectural decisions are consistently applied across your projects, all from the comfort of your terminal.
Install
cd cli
pip install -e .
Requires Python 3.8+ and requests.
Quick start
# 1. Save your API key (from markdownlm dashboard → Settings)
mdlm configure
# 2. Clone your knowledge base into ./knowledge/
mdlm clone
# 3. Edit any .md file in ./knowledge/
# 4. See what changed
mdlm status
# 5. Push changes back
mdlm push -m "update auth docs"
# 6. Query your patterns
mdlm query "How to handle errors?" -c error_handling
# 7. Validate code vs rules
mdlm validate app/api.py -t "Add user endpoint" -c security
Commands
| Command | Description |
|---|---|
mdlm configure |
Save API key to ~/.config/mdlm/config (mode 0600) |
mdlm clone [-c CAT] |
Download all docs → ./knowledge/ |
mdlm pull |
Refresh docs from server (overwrites local) |
mdlm status |
Show new / modified / deleted files |
mdlm push [-m MSG] [-c CAT] [--delete] |
Upload local changes |
mdlm query Q [-c CAT] |
Query rules/patterns (def: general) |
mdlm validate CODE -t TASK [-c CAT] |
Check code vs rules |
mdlm resolve-gap Q [-c CAT] |
Resolve documentation gaps |
Security
- Your API key is stored in
~/.config/mdlm/configwith permissions0600(owner read/write only). - Set
MDLM_API_KEYenv var to override without touching the config file. - Keys are never echoed to the terminal (
getpassis used duringconfigure). - HTTPS is enforced;
http://URLs are rejected at startup. - Conflict detection:
pushchecks the remote version before overwriting — runmdlm pullif there's a conflict. --deleteflag is required to delete remote docs; omitting it is the safe default.
Metadata
Release files for mdlm 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mdlm-0.2.1.tar.gz | 12.5 kB | Without provenance | Details for mdlm-0.2.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mdlm-0.2.1-py3-none-any.whl | Python 3 | none | any | Details for mdlm-0.2.1-py3-none-any.whl |
Total release size: 25.7 kB
Release files / mdlm-0.2.1.tar.gz
| Download URL | mdlm-0.2.1.tar.gz |
|---|---|
| Size | 12.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b8a3195e287eee2c24c737f70c04850ce2d71370ed19fe4f99931fc2e4ce023e
|
|
BLAKE2b-256 checksum How to use checksums |
84179d2902dab19c0a6adb314ffcf78457961f4a9bb0521d8b2e64482bce0523
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.2
|
Release files / mdlm-0.2.1-py3-none-any.whl
| Download URL | mdlm-0.2.1-py3-none-any.whl |
|---|---|
| Size | 13.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
04a6976eac52405e2e106fe65f7d9bfc5caebf69bb098550277322dcbc8e3a49
|
|
BLAKE2b-256 checksum How to use checksums |
0ef48eb4e7afd21f4f3225df983bc67fd032fee74166f1c2c8b5238cf273af39
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.2
|
Security for mdlm 0.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.