{"id":31074176,"url":"https://github.com/akornatskyy/backscribe","last_synced_at":"2026-03-04T12:08:13.636Z","repository":{"id":314093918,"uuid":"1054112785","full_name":"akornatskyy/backscribe","owner":"akornatskyy","description":"🔄 Backup + scribe (a shell script writer).","archived":false,"fork":false,"pushed_at":"2025-10-22T07:48:54.000Z","size":56,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-22T09:31:17.282Z","etag":null,"topics":["backup-script","shell"],"latest_commit_sha":null,"homepage":"","language":"Go","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/akornatskyy.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-10T11:37:26.000Z","updated_at":"2025-10-22T07:48:57.000Z","dependencies_parsed_at":"2025-10-22T09:21:25.515Z","dependency_job_id":"362d2e66-8603-40d0-80de-f22c755cf5d5","html_url":"https://github.com/akornatskyy/backscribe","commit_stats":null,"previous_names":["akornatskyy/backscribe"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/akornatskyy/backscribe","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akornatskyy%2Fbackscribe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akornatskyy%2Fbackscribe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akornatskyy%2Fbackscribe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akornatskyy%2Fbackscribe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/akornatskyy","download_url":"https://codeload.github.com/akornatskyy/backscribe/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akornatskyy%2Fbackscribe/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30079565,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T11:57:42.557Z","status":"ssl_error","status_checked_at":"2026-03-04T11:56:10.793Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":["backup-script","shell"],"created_at":"2025-09-16T02:05:23.421Z","updated_at":"2026-03-04T12:08:13.611Z","avatar_url":"https://github.com/akornatskyy.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# backscribe\n\n[![tests](https://github.com/akornatskyy/backscribe/actions/workflows/tests.yml/badge.svg)](https://github.com/akornatskyy/backscribe/actions/workflows/tests.yml)\n\n*Backscribe* is a flexible command generator for archiving, copying, and backing up files, driven by structured configuration definitions. It outputs a series of shell commands that you can review or pipe directly into your shell (e.g., via `sh` or `bash`).\n\n## Usage\n\n```text\nUsage:\n  backscribe [options]\n\nDescription:\n  backscribe generates a sequence of shell commands based on a configuration.\n  If no configuration file is specified, it searches upward from the current\n  directory for a file named '[.]backscribe.(yaml|json)'.\n  Also checks $HOME and $HOME/.config\n\nOptions:\n  -c, --config \u003cfile\u003e   Optional path to a config file\n  -h, --help            Show this help message\n  -v, --version         Show version\n\nExamples:\n  backscribe -c ./config/backscribe.yaml | sh\n  backscribe | sh  # Auto-searches for config\n```\n\n## Prerequisites\n\nThe 7z ([7-Zip](https://sourceforge.net/projects/sevenzip/files/7-Zip/)) command-line tool must be installed and discoverable in your system’s PATH. You should be able to run 7z from any terminal or shell without specifying its full path.\n\n## Behavior\n\nIf no config is specified, `backscribe` searches upward from the current directory for:\n\n- backscribe.{yaml,yml,json}\n- .backscribe.{yaml,yml,json}\n\nIt also checks `$HOME` and `$HOME/.config` directories.\n\n## Configuration Format\n\nYour configuration defines groups of file operations. Each group contains archives that describe what to back up or copy.\n\nArchive Types:\n\n- 7z: Create a .7z archive\n- tar: Create a .tar archive\n- cp: Copy files directly\n\n## Example Configs\n\n✅ YAML\n\n```yaml\ngroups:\n  - name: home\n    archives:\n      - type: 7z\n        name: dotfiles\n        files:\n          - ~/.*\n        exclude:\n          - .cache\n```\n\n✅ JSON\n\n```json\n{\n  \"groups\": [\n    {\n      \"name\": \"home\",\n      \"archives\": [\n        {\n          \"type\": \"7z\",\n          \"name\": \"dotfiles\",\n          \"files\": [\"~/.*\"],\n          \"exclude\": [\".cache\"]\n        }\n      ]\n    }\n  ]\n}\n```\n\n## Environment Variable Expansion\n\nYou can use environment variables in paths, like:\n\n```yaml\ngroups:\n  - name: roaming\n    archives:\n      - type: 7z\n        name: Roaming\n        files:\n          - ${APPDATA}/Code\n```\n\n## Visual Studio Code\n\nSee `.vscode/settings.json` for enabling schema validation, auto-completion, and hover tooltips with documentation for *backscribe* files.\n\n## Building from Source\n\n```sh\ngit clone https://github.com/akornatskyy/backscribe.git\ncd backscribe\ngo build\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakornatskyy%2Fbackscribe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fakornatskyy%2Fbackscribe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakornatskyy%2Fbackscribe/lists"}