{"id":20382113,"url":"https://github.com/drhdev/tarup","last_synced_at":"2026-06-08T05:32:20.631Z","repository":{"id":253991344,"uuid":"845158378","full_name":"drhdev/tarup","owner":"drhdev","description":"A linux shellscript that allows you to create backups in tar.gz formal from local directory with exclusions.","archived":false,"fork":false,"pushed_at":"2024-08-20T17:42:14.000Z","size":19,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-04T22:42:00.479Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/drhdev.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-08-20T17:37:44.000Z","updated_at":"2024-08-20T17:42:17.000Z","dependencies_parsed_at":"2024-08-20T20:04:12.388Z","dependency_job_id":null,"html_url":"https://github.com/drhdev/tarup","commit_stats":null,"previous_names":["drhdev/tarup"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/drhdev/tarup","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drhdev%2Ftarup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drhdev%2Ftarup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drhdev%2Ftarup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drhdev%2Ftarup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/drhdev","download_url":"https://codeload.github.com/drhdev/tarup/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drhdev%2Ftarup/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34050224,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-08T02:00:07.615Z","response_time":111,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2024-11-15T02:16:36.731Z","updated_at":"2026-06-08T05:32:20.614Z","avatar_url":"https://github.com/drhdev.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tarup\n\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n\n## Overview\n\n`tarup.sh` is a versatile Bash script designed to create tarball archives of directories with optional exclusion of certain files and directories. It supports custom exclusion sets and generates tarballs with a default filename format that includes the date, server name, and directory name. The script also ensures that the output file is not included in the archive.\n\n## Features\n\n- **Customizable Exclusions**: Choose between no exclusions, all common exclusions, or provide a custom list of files and directories to exclude.\n- **Automatic Exclusion of Output File**: The script automatically excludes the tarball it is generating from the archive.\n- **Default Filename Format**: The output file is named using the format `YYYYMMDD_tarup_[servername]_[directory].tar.gz`, where `YYYYMMDD` is the current date, `[servername]` is the hostname, and `[directory]` is the directory being archived.\n- **Flexible Output Options**: Specify the output file's path and name if the default format doesn't suit your needs.\n\n## Installation\n\n1. **Clone the Repository:**\n   ```bash\n   git clone https://github.com/drhdev/tarup.git\n   ```\n   \n2. **Navigate to the Repository Directory:**\n   ```bash\n   cd tarup\n   ```\n   \n3. **Make the Script Executable:**\n   ```bash\n   chmod +x tarup.sh\n   ```\n\n## Usage\n\n```bash\n./tarup.sh [OPTIONS]\n```\n\n### Options\n\n- **`-e [none|all|custom]`**: Specify the exclusion set.\n  - `none`   - No exclusions.\n  - `all`    - Full set of common exclusions (default).\n  - `custom` - Provide a custom list of exclusions (comma-separated).\n\n- **`-o [output_file]`**: Specify the output tar.gz file's path and name.\n\n- **`-h`, `-help`**: Display the help message.\n\n### Default Behavior\n\n- If no options are provided, the script uses the `all` exclusion set and creates a tarball named `YYYYMMDD_tarup_[servername]_[directory].tar.gz` in the current directory.\n\n### Example Commands\n\n1. **Run with Default Settings (All Exclusions):**\n   ```bash\n   ./tarup.sh\n   ```\n\n2. **Run with No Exclusions:**\n   ```bash\n   ./tarup.sh -e none\n   ```\n\n3. **Run with Custom Exclusions:**\n   ```bash\n   ./tarup.sh -e custom -e \"*.log,.cache,.env\"\n   ```\n\n4. **Specify a Custom Output File:**\n   ```bash\n   ./tarup.sh -o /path/to/output/file.tar.gz\n   ```\n\n5. **Display Help:**\n   ```bash\n   ./tarup.sh -h\n   ./tarup.sh -help\n   ```\n\n## Example\n\nSuppose you are in the `/home/user/project` directory on a server named `myserver`, and you run the following command:\n\n```bash\n./tarup.sh\n```\n\nThe script will create a tarball named `20240820_tarup_myserver_project.tar.gz` in the `/home/user/project` directory, excluding common system files, cached files, and any files listed in the `all` exclusion set.\n\n## License\n\nThis project is licensed under the GPL-3.0 License. See the [LICENSE](LICENSE) file for more details.\n\n## Contributions\n\nContributions are welcome! Please submit pull requests or open issues to suggest improvements or report bugs.\n\n## Acknowledgments\n\nThis script was developed to provide a simple yet powerful way to create backups of directories while allowing for flexible exclusion of unwanted files.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdrhdev%2Ftarup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdrhdev%2Ftarup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdrhdev%2Ftarup/lists"}