{"id":20475152,"url":"https://github.com/toolworks-dev/auto-md","last_synced_at":"2025-04-13T12:29:08.880Z","repository":{"id":262779694,"uuid":"888324878","full_name":"toolworks-dev/auto-md","owner":"toolworks-dev","description":" Convert Files / Folders / GitHub Repos Into AI / LLM-ready Files ","archived":false,"fork":false,"pushed_at":"2024-11-14T08:14:56.000Z","size":65,"stargazers_count":26,"open_issues_count":1,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-27T03:34:44.756Z","etag":null,"topics":["ai","ai-tool","convert","github","llm","llm-tools","md","python","python-convert","python-script","scrape","webapp"],"latest_commit_sha":null,"homepage":"https://automd.toolworks.dev","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/toolworks-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-14T07:51:07.000Z","updated_at":"2025-03-20T22:00:52.000Z","dependencies_parsed_at":"2024-11-14T08:41:54.269Z","dependency_job_id":null,"html_url":"https://github.com/toolworks-dev/auto-md","commit_stats":null,"previous_names":["toolworks-dev/auto-md"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toolworks-dev%2Fauto-md","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toolworks-dev%2Fauto-md/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toolworks-dev%2Fauto-md/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toolworks-dev%2Fauto-md/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/toolworks-dev","download_url":"https://codeload.github.com/toolworks-dev/auto-md/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248713805,"owners_count":21149780,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","ai-tool","convert","github","llm","llm-tools","md","python","python-convert","python-script","scrape","webapp"],"created_at":"2024-11-15T15:14:49.700Z","updated_at":"2025-04-13T12:29:08.859Z","avatar_url":"https://github.com/toolworks-dev.png","language":"Python","readme":"# ~auto~md~\n\n### Python tool that converts various file types and GitHub repositories into Markdown documents (.md) optimized for quick RAG/indexing via large language models (LLMs)\n\nTry the web version at https://automd.toolworks.dev\n\n![screen](auto-md-gui-screen.png)\n\n## Features\n\n- Supports multiple file types (see table below)\n- Processes zip files/folders/individual files and GitHub repositories\n- Generates a single Markdown file or multiple files\n- Creates a table of contents and metadata for each file processed\n\n## Supported File Extensions\n\n| Category | Extensions |\n|----------|------------|\n| Text | .txt, .text, .log |\n| Markdown | .md, .markdown, .mdown, .mkdn, .mkd, .mdwn, .mdtxt, .mdtext |\n| Web | .html, .htm, .xhtml, .shtml, .css, .scss, .sass, .less |\n| Programming | .py, .pyw, .js, .jsx, .ts, .tsx, .java, .c, .cpp, .cs, .go, .rb, .php, .swift, .kt |\n| Data | .json, .jsonl, .yaml, .yml, .xml, .csv, .tsv |\n| Config | .ini, .cfg, .conf, .config, .toml, .editorconfig |\n| Shell | .sh, .bash, .zsh, .fish, .bat, .cmd, .ps1 |\n| Other | .rst, .tex, .sql, .r, .lua, .pl, .scala, .clj, .ex, .hs, .ml, .rs, .vim |\n\n## Quick Setup Guide\n\n1. Install Python 3.7 or newer\n\n2. Download this project (or clone repo like normal):\n   - Click the green \"Code\" button above\n   - Choose \"Download ZIP\"\n   - Extract the ZIP file\n\n3. Open a terminal/command prompt and navigate to the extracted folder:\n   ```\n   cd path/to/Auto-MD\n   ```\n\n4. Install required packages:\n   ```\n   pip install -r requirements.txt\n   ```\n\n5. Run the application:\n   ```\n   python main.py\n   ```\n\n6. Use the GUI to:\n   - Select input files/folders\n   - Choose output location\n   - Set processing options\n   - Click \"Start Processing\"\n\n## Example Input/Output\n\n### Input\n\nLet's say you have the following files in a folder called \"my_project\":\n\n- README.md\n- script.py\n- data.json\n- styles.css\n\n### Output\n\nAfter processing with Auto MD, you would get a single Markdown file (`output.md`) that looks like the example below\n\nThis single .md file contains all the content from your input files, with a table of contents at the top for easy navigation and referencing / indexing via LLM models\n\n```markdown\n# Auto MD Output\n\n## Table of Contents\n- [README](#readme)\n- [script](#script)\n- [data](#data)\n- [styles](#styles)\n\n---\n\n# README\n\n## Metadata\n- **Generated on:** 2024-06-30 16:30:15\n- **Source:** my_project\n\n(Content of README.md)\n\n---\n\n# script\n\n## Metadata\n- **Generated on:** 2024-06-30 16:30:16\n- **Source:** my_project\n\n(Content of script.py)\n\n---\n\n# data\n\n## Metadata\n- **Generated on:** 2024-06-30 16:30:17\n- **Source:** my_project\n\n(Content of data.json)\n\n---\n\n# styles\n\n## Metadata\n- **Generated on:** 2024-06-30 16:30:18\n- **Source:** my_project\n\n(Content of styles.css)\n```\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoolworks-dev%2Fauto-md","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftoolworks-dev%2Fauto-md","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoolworks-dev%2Fauto-md/lists"}