{"id":22962225,"url":"https://github.com/simplysabir/file-aggregator","last_synced_at":"2025-04-02T03:24:21.169Z","repository":{"id":251506099,"uuid":"837582563","full_name":"simplysabir/file-aggregator","owner":"simplysabir","description":"The ultimate file aggregation tool! If you've ever needed to consolidate multiple files from a directory into a single file effortlessly","archived":false,"fork":false,"pushed_at":"2024-08-03T15:49:39.000Z","size":18,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-08T19:33:50.631Z","etag":null,"topics":["aggregation","aggregator","cli","clipboard","file","file-aggregation"],"latest_commit_sha":null,"homepage":"https://crates.io/crates/fileagg","language":"Rust","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/simplysabir.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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-08-03T11:58:48.000Z","updated_at":"2024-11-02T14:11:26.000Z","dependencies_parsed_at":"2024-08-06T09:13:14.296Z","dependency_job_id":null,"html_url":"https://github.com/simplysabir/file-aggregator","commit_stats":null,"previous_names":["simplysabir/file-aggregator","simplysabir/file_aggregator"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplysabir%2Ffile-aggregator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplysabir%2Ffile-aggregator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplysabir%2Ffile-aggregator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplysabir%2Ffile-aggregator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simplysabir","download_url":"https://codeload.github.com/simplysabir/file-aggregator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246748498,"owners_count":20827320,"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":["aggregation","aggregator","cli","clipboard","file","file-aggregation"],"created_at":"2024-12-14T19:16:09.324Z","updated_at":"2025-04-02T03:24:21.144Z","avatar_url":"https://github.com/simplysabir.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# File Aggregator (`fileagg`)\n![](https://i.imgur.com/bHEFnTd.png)\n\nWelcome to `fileagg`, the ultimate file aggregation tool! If you've ever needed to consolidate multiple files from a directory into a single file effortlessly, `fileagg` is your go-to solution. With features like respecting `.gitignore`, excluding `node_modules`, and supporting multiple output options, `fileagg` makes file management a breeze.\n\n## Features\n\n- **Aggregate File Contents**: Combine contents from all files in a directory into one file.\n- **Respects `.gitignore`**: Automatically skip files listed in `.gitignore`.\n- **Excludes `node_modules`**: No more unnecessary bloat in your aggregated output.\n- **Flexible Output Options**: Save to a file, print to console, or copy directly to clipboard.\n- **Include Hidden Files**: Optionally include hidden files in your aggregation.\n- **Filter by File Type**: Only aggregate specific file types you care about.\n- **Progress Indication**: See real-time progress as files are processed.\n\n## Installation\n\n### Prerequisites\n\nEnsure you have [Rust](https://www.rust-lang.org/tools/install) and Cargo installed on your system.\n\n### Installing via Cargo\n\nTo install `fileagg` as a Cargo package, run the following command:\n\n```bash\ncargo install fileagg\n```\n\n### Building Locally\n\nIf you prefer to build `fileagg` from source:\n\n1. Clone the repository or download the source code.\n\n2. Navigate to the project directory:\n\n   ```bash\n   cd path/to/your/fileagg\n   ```\n\n3. Build and install locally:\n\n   ```bash\n   cargo install --path .\n   ```\n\n## Usage\n\n### Default Behavior\n\nBy default, `fileagg` aggregates files in the current directory and saves the output to `fileagg_output.txt`.\n\n```bash\nfileagg\n```\n\n### Commands and Options\n\n#### 1. Specify Directory\n\nAggregate files from a specific directory:\n\n```bash\nfileagg /path/to/directory\n```\n\n#### 2. Specify Output File\n\nTo customize the output file location and name:\n\n```bash\nfileagg --output result.txt\n```\n\nThis command saves the output to `result.txt`.\n\n#### 3. Print to Standard Output\n\nTo print the aggregated contents to the console:\n\n```bash\nfileagg --stdout\n```\n\n#### 4. Copy to Clipboard\n\nCopy the aggregated contents to your clipboard:\n\n```bash\nfileagg --clipboard\n```\n\n#### 5. Include Hidden Files\n\nTo include hidden files (e.g., `.env`, `.gitignore`):\n\n```bash\nfileagg --include-hidden\n```\n\n#### 6. Ignore `.gitignore` Rules\n\nIf you want to ignore `.gitignore` rules and include all files:\n\n```bash\nfileagg --no-ignore\n```\n\n#### 7. Filter by File Types\n\nAggregate only specific file types:\n\n```bash\nfileagg --file-types rs,js,py\n```\n\n### Example Commands\n\n1. Aggregate all files in the current directory and save to `fileagg_output.txt`:\n\n   ```bash\n   fileagg\n   ```\n\n2. Aggregate files from a specific directory and save to `custom_output.txt`:\n\n   ```bash\n   fileagg /path/to/directory --output custom_output.txt\n   ```\n\n3. Include hidden files and print output to console:\n\n   ```bash\n   fileagg --include-hidden --stdout\n   ```\n\n4. Aggregate specific file types and copy to clipboard:\n\n   ```bash\n   fileagg --file-types md,txt --clipboard\n   ```\n\n## Notes\n\n- **Node Modules Exclusion**: `fileagg` automatically skips files in the `node_modules` directory.\n- **Default Output**: If no output method is specified, results are saved to `fileagg_output.txt`.\n- **Safety First**: Ensure the output file isn't in the list of files to aggregate to prevent overwriting.\n\n## Contributing\n\nWe welcome contributions! Feel free to submit issues, pull requests, or ideas for improvements.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.\n\n## Contact\n\nFor questions or feedback, reach out to [simplysabir](https://github.com/simplysabir).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplysabir%2Ffile-aggregator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimplysabir%2Ffile-aggregator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplysabir%2Ffile-aggregator/lists"}