{"id":28723734,"url":"https://github.com/blackvoidx/tree-scribe","last_synced_at":"2026-04-25T11:31:56.955Z","repository":{"id":270062439,"uuid":"900065255","full_name":"blackvoidx/tree-scribe","owner":"blackvoidx","description":"This script generates a visual representation of the directory structure","archived":false,"fork":false,"pushed_at":"2025-02-16T13:33:55.000Z","size":42,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-01-18T19:40:23.286Z","etag":null,"topics":["github-actions","pip","pipx","pypi","python3","tree"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/tree-scribe/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/blackvoidx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-12-07T19:09:27.000Z","updated_at":"2025-02-16T13:33:59.000Z","dependencies_parsed_at":null,"dependency_job_id":"fb0aeeef-fa0a-4549-bfce-5113281f0e0b","html_url":"https://github.com/blackvoidx/tree-scribe","commit_stats":null,"previous_names":["mamad-1999/tree-scribe","blackvoidx/tree-scribe"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/blackvoidx/tree-scribe","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackvoidx%2Ftree-scribe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackvoidx%2Ftree-scribe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackvoidx%2Ftree-scribe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackvoidx%2Ftree-scribe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blackvoidx","download_url":"https://codeload.github.com/blackvoidx/tree-scribe/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackvoidx%2Ftree-scribe/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32261017,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-25T09:15:33.318Z","status":"ssl_error","status_checked_at":"2026-04-25T09:15:31.997Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["github-actions","pip","pipx","pypi","python3","tree"],"created_at":"2025-06-15T09:34:34.665Z","updated_at":"2026-04-25T11:31:56.942Z","avatar_url":"https://github.com/blackvoidx.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Directory Tree Script\n\nThis script generates a visual representation of the directory structure of a specified root directory. It supports exporting the structure to a Markdown file and offers various options to customize the output.\n\n```\nUsage: tree-script [SWITCHES] directory\n\nGenerate a directory tree structure for a given path, with options for depth\nlimitation, colorful output, file sizes, and exporting to Markdown.\n\npositional arguments:\n  directory             Path to the root directory to analyze\n\noptional arguments:\n  -h, --help            Show this help message and exit\n  -md, --export-md      Export the directory structure to a Markdown file\n  -d DEPTH, --depth DEPTH\n                        Limit the depth of directory traversal (e.g., -d 2)\n  -v, --verbose         Enable verbose logging for debugging purposes\n  -c, --color           Enable colorful output for better readability\n  -s, --size            Show file sizes and line counts in the output\n\nExamples:\n  tree-script /path/to/directory\n  tree-script /path/to/directory -d 2 -s\n  tree-script /path/to/directory -md -c\n```\n\n### Example Output\n\n![-d](https://github.com/user-attachments/assets/dea8ad31-55ae-4658-9ccd-06074719c769)\n\n## Installation\n\n```bash\n pip install tree-scribe\n```\n\nOr\n\n```bash\n pipx install tree-scribe\n```\n\n## Command-Line Switches\n\n| Switch/Option            | Description                                                     | Example Usage                                              |\n| ------------------------ | --------------------------------------------------------------- | ---------------------------------------------------------- |\n| `\u003cdirectory-path\u003e`       | Path to the root directory whose structure you want to display. | `tree-scribe /home/project`                                |\n| `-md`, `--export-md`     | Export the directory structure to a Markdown file.              | `tree-scribe /home/project -md`                            |\n| `-d`, `--depth \u003cnumber\u003e` | Limit the depth of directory traversal.                         | `tree-scribe /home/project -d 2`                           |\n| `-v`, `--verbose`        | Enable verbose logging for detailed output.                     | `tree-scribe /home/project -v`                             |\n| `-c`, `--color`          | Enable colorful output in the terminal.                         | `tree-scribe /home/project -c`                             |\n| `-s`, `--size`           | Show line and size.                                             | `tree-scribe /home/project -s`                             |\n| `--exclude`              | Exclude file and folder.                                        | `tree_scribe /path/to/directory --exclude dist build .git` |\n\n## Examples\n\n1. **Display the Directory Structure**\n\n   ```bash\n   tree-scribe /home/project\n   ```\n\n2. **Export to Markdown**\n\n   ```bash\n   tree-scribe /home/project --export-md\n   ```\n\n3. **Limit Depth to 2 Levels**\n\n   ```bash\n   tree-scribe /home/project --depth 2\n   ```\n\n4. **Enable Verbose Logging**\n\n   ```bash\n   tree-scribe /home/project --verbose\n   ```\n\n5. **Enable Colorful Output**\n\n   ```bash\n   tree-scribe /home/project -c\n   ```\n\n6. **Show line and size**\n\n   ```bash\n   tree-scribe /home/project -s\n   ```\n\n7. **Combine Options**\n\n   ```bash\n   tree-scribe /home/project --export-md --depth 3 -c -s\n   ```\n\n8. **Exclude files or folder**\n\n   ```bash\n   tree_scribe /path/to/directory --exclude dist build .git\n   ```\n\n### Troubleshooting\n\n- Permission Errors: If you encounter permission errors, make sure you have the necessary permissions to access the directories and files.\n- Invalid Directory Path: Ensure the specified directory path is correct and exists.\n\n### License\n\nThis script is provided under the MIT License. See the LICENSE file for more information.\n\n### Contributing\n\nFeel free to submit issues, suggestions, or pull requests. Contributions are welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblackvoidx%2Ftree-scribe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblackvoidx%2Ftree-scribe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblackvoidx%2Ftree-scribe/lists"}