{"id":17006248,"url":"https://github.com/codefromanywhere/summarize-folder","last_synced_at":"2025-03-22T10:50:24.485Z","repository":{"id":248912093,"uuid":"828939954","full_name":"CodeFromAnywhere/summarize-folder","owner":"CodeFromAnywhere","description":"Summarize folders","archived":false,"fork":false,"pushed_at":"2024-08-16T14:30:50.000Z","size":17,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-28T21:05:02.725Z","etag":null,"topics":["code"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/CodeFromAnywhere.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-07-15T12:36:55.000Z","updated_at":"2024-11-14T11:41:54.000Z","dependencies_parsed_at":"2024-07-17T22:23:51.424Z","dependency_job_id":null,"html_url":"https://github.com/CodeFromAnywhere/summarize-folder","commit_stats":null,"previous_names":["codefromanywhere/summarize-folder"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeFromAnywhere%2Fsummarize-folder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeFromAnywhere%2Fsummarize-folder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeFromAnywhere%2Fsummarize-folder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeFromAnywhere%2Fsummarize-folder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CodeFromAnywhere","download_url":"https://codeload.github.com/CodeFromAnywhere/summarize-folder/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235839923,"owners_count":19053335,"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":["code"],"created_at":"2024-10-14T05:05:20.689Z","updated_at":"2025-01-27T10:41:40.544Z","avatar_url":"https://github.com/CodeFromAnywhere.png","language":"JavaScript","readme":"# summarize-folder\n\n`summarize-folder` is a powerful Node.js CLI tool designed to analyze and manipulate folder structures and file contents. It offers three main functionalities: summarizing folder structures, reading file hierarchies, and writing file hierarchies.\n\n## Features\n\n- **Folder Summarization**: Scan folders recursively and generate a YAML file containing file sizes.\n- **File Hierarchy Reading**: Retrieve and prune file contents based on a given structure.\n- **File Hierarchy Writing**: Write file contents to a specified structure.\n- **Gitignore Support**: Respects `.gitignore` and `.genignore` files for excluding files/folders.\n- **UTF-8 Compatibility**: Ignores non-UTF-8 encoded files.\n\n## Installation\n\n```bash\nnpm install -g summarize-folder\n```\n\n## Usage\n\n### Summarize Folder Sizes\n\n```bash\nsummarize-folder size [path]\n```\n\nScans the current folder or specified path recursively and generates a `summary-filesizes.yaml` file containing the character count for each file.\n\n### Read File Hierarchy\n\n```bash\nsummarize-folder read \u003cinput_path\u003e \u003coutput_path\u003e [maxDepth]\n```\n\nRetrieves the content for a pruned file list based on the structure defined in the input YAML file.\n\n### Write File Hierarchy\n\n```bash\nsummarize-folder write \u003cpath-to-yaml-file\u003e\n```\n\nWrites file contents to the file system based on the structure and content defined in the input YAML file.\n\n## Configuration\n\n- `.gitignore`: Standard Git ignore file, respected by the tool.\n- `.genignore`: Additional ignore file specific to this tool.\n\n## Dependencies\n\n- `yaml`: Used for parsing and stringifying YAML content.\n\n## License\n\nISC\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## Support\n\nIf you encounter any problems or have any questions, please open an issue in the GitHub repository.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodefromanywhere%2Fsummarize-folder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodefromanywhere%2Fsummarize-folder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodefromanywhere%2Fsummarize-folder/lists"}