{"id":14062898,"url":"https://github.com/dbzix/EasyStow","last_synced_at":"2025-07-29T14:31:57.454Z","repository":{"id":240442838,"uuid":"802654887","full_name":"dbzix/EasyStow","owner":"dbzix","description":"Manage your dotfiles with pleasure!","archived":false,"fork":false,"pushed_at":"2025-04-14T22:57:59.000Z","size":14,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-14T23:31:54.607Z","etag":null,"topics":["bash","dotfiles","stow"],"latest_commit_sha":null,"homepage":"","language":null,"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/dbzix.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":"dbzix","issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":null,"custom":null}},"created_at":"2024-05-18T22:22:52.000Z","updated_at":"2025-04-14T22:58:02.000Z","dependencies_parsed_at":"2024-05-18T22:38:14.502Z","dependency_job_id":"a6ffa2ad-8380-4df0-9c0e-b512661d830d","html_url":"https://github.com/dbzix/EasyStow","commit_stats":null,"previous_names":["dbzix/easystow"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dbzix/EasyStow","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbzix%2FEasyStow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbzix%2FEasyStow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbzix%2FEasyStow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbzix%2FEasyStow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dbzix","download_url":"https://codeload.github.com/dbzix/EasyStow/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbzix%2FEasyStow/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267703041,"owners_count":24130463,"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","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"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":["bash","dotfiles","stow"],"created_at":"2024-08-13T07:02:48.529Z","updated_at":"2025-07-29T14:31:57.438Z","avatar_url":"https://github.com/dbzix.png","language":null,"funding_links":["https://liberapay.com/dbzix"],"categories":["Others"],"sub_categories":[],"readme":"# EasyStow  - dotfiles made simple!\n\n**EasyStow** is a set of custom `bash` commands built over the [GNU Stow](https://www.gnu.org/software/stow/manual/stow.html) to make [dotfiles](https://dotfiles.github.io/) management pleasant.\n\u003e **Note**: `GNU stow` operates on [packages](https://www.gnu.org/software/stow/manual/stow.html#Terminology) - minimal working units that represent collections of files and directories to back up.\n\n## Why?\n\nWhen you manage dotfiles with pure `GNU Stow`, you have to retain multiple command line options in your head.\n\nBy default, `GNU Stow` implies that the [stow directory](https://www.gnu.org/software/stow/manual/stow.html#Terminology) is your current directory, and your [target directory](https://www.gnu.org/software/stow/manual/stow.html#Terminology) is just its parent. If this is your case, you don't have to specify additional options to execute the `stow` command - everything is fine by default.\n\nBut if your current directory isn't where you store your dotfiles, you must provide paths to your `stow directory` and to your `target directory` (depending on your current location). This does not seem as a convenient workflow, isn't it?\n\n**So, here is the EasyStow**.\n\n## How?\n\nIt's just the `bash` script that defines custom commands (implemented as simple `bash` aliases and functions) for manipulating `stow` backups.\\\nThese commands are:\n- aliases for expore your storage:\n    \u003e `stow-ls-structure` - to show the structure of your dotfiles\\\n    \u003e `stow-ls-packages` - to list all stowed packages\n- functions to manage your storage:\n    \u003e `stow-simulate` - to run stow packaging in simulation mode (`stow` option `-n`)\\\n    \u003e `stow-do` - to stow packages\\\n    \u003e `stow-force` - to stow packages in forced mode (`stow` option `--adopt`)\\\n    \u003e `stow-unstow` - to un-stow packages (`stow` option `-D`)\\\n    \u003e `stow-restow` - to re-stow packages (`stow` option `-R`)\n\nUsing this, you can manage your backups **from any place** in the system and **without providing** any additional arguments.\\\nAlso, thanks to **autocompletion** implemented in the script, you have full control over your dotfiles.\n\n## Dotfiles storage structure\n\n**EasyStow** operates on `categories` and `packages`.\n\nWhat you have inside your root dotfiles directory are `categories`, with one special category - `secrets` - which has its own `sub-categories`. The purpose of `secrets` category is to back up anything that contains sensitive data like *passwords*, *auth keys*, etc.\n\nWhat's inside `categories` and `sub-categories` is treated as `packages.`\n\nExample:\n```\n$HOME/backup/dotfiles (default location)\n             ├── configs\n             ├── shells\n             ├── tools\n             └── secrets\n                 ├── encryption\n                 └── remote\n```\nHere, you have `category` directory `shells` where you plan to store `packages` that represent miscellaneous shell-related config files.\\\nThen you might have `sub-directoriess` - `shells/bash` and `shells/zsh` - each storing a set of config files for respective shell.\\\nHere `bash` and `zsh` are `packages.`\n\n## Installation\n\nInstall *GNU Stow*:\n```bash\n$ apt install stow\n```\nClone this repository:\n```bash\ncd ~\ngit clone https://github.com/dbzix/EasyStow\n```\nAdd the following to your shell configuration (e.g. `.bashrc`):\n```bash\nexport DOTFILES_ROOT_DIR=$HOME/path/to/your/dotfiles\nif [ -f $HOME/EasyStow/easystow ]; then\n    . $HOME/EasyStow/easystow\nfi\n```\nDone!\\\nNow you have full control over your *dotfiles*!\n\n## Usage\n \nThe usage is:\n```bash\nstow-command [secrets] \u003ccategory\u003e \u003cpackage\u003e [\u003cpackage\u003e \u003cpackage\u003e ...] [-v]\n```\nfor manipulating ***specific packages*** in selected *category*;\\\nor:\n```bash\nstow-command [secrets] \u003ccategory\u003e [-v]\n```\nfor manipulating ***all packages*** in selected *category*.\n\nHere, `stow-command` is one of: `stow-simulate`, `stow-do`, `stow-force`, `stow-unstow`, and `stow-restow`.\n\n\u003cdetails\u003e\n    \u003csummary\u003eThe \u003ctt\u003e-v\u003c/tt\u003e option is for additional verbosity.\u003c/summary\u003e\n\n  Compare this:\n  ```\n  $ stow-do homeroot git\n  Processing packages in 'homeroot' category: git\n  $\n  ```\n\n  and this:\n  ```\n  $ stow-do homeroot git -v\n  Processing packages in 'homeroot' category: git\n  stow dir is /home/username/backup/dotfiles/homeroot\n  stow dir path relative to target /home/username is backup/dotfiles/homeroot\n  Planning stow of package git...\n  --- Skipping .gitignore as it already points to backup/dotfiles/homeroot/git/.gitignore\n  --- Skipping .gitconfig as it already points to backup/dotfiles/homeroot/git/.gitconfig\n  Planning stow of package git... done\n  Processing tasks...\n  $\n  ```\n\n  The `-v` option may help you understand what's happening in some cases.\\\n  You may add more `-v` flags. They will be passed to `stow` command, adding even more verbosity.\n\u003c/details\u003e\n\n## Examples\n\n\u003cdetails\u003e\n  \u003csummary\u003e1. Simulate what `stow` will do for you.\u003c/summary\u003e\n\n  ```\n  stow-simulate secrets homeroot ssh\n  ```\n\n  \u003e This way you ensure what exactly will be done on your system after applying the `stow` command.\\\n  \u003e Here you ran the `stow` simulation on your *secret* `ssh` package which is stowed under the `homeroot` category.\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e2. Store \u003ci\u003enew piece\u003c/i\u003e of configuration \u003cb\u003e/\u003c/b\u003e Apply stowed configuration on \u003ci\u003enew machine\u003c/i\u003e.\u003c/summary\u003e\n\n  ```\n  stow-do homeroot bash\n  ```\n\n  \u003e In this example you stow your `bash` configuration package inside the `homeroot` category under your *storage root*.\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e3. Update stowed content.\u003c/summary\u003e\n\n  Some programs tend to replace symlink(s) with plain file(s).\\\n  In this case, when you apply the `stow-do` command, `stow` rejects it.\n  If that is the case, you may force `stow` to **rewrite** your stowed configuration with new content and then re-create symlinks by executing:\n  \n  ```\n  stow-force homeroot goldendict\n  ```\n\n  \u003e You should use this command **with caution** because old stowed content will be **replaced** with the new one.\\\n  \u003e You are safe here if you use `git` to track the changes you make in your backups.\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e4. Un-stow (\u003ci\u003eremove symlinks\u003c/i\u003e to stowed package).\u003c/summary\u003e\n\n  ```\n  stow-unstow homeroot kazam\n  ```\n\n  \u003e This might be helpful when you *uninstall* some software, and you don't need unnecessary symlinks in your system.\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e5. Re-stow (\u003ci\u003eremove\u003c/i\u003e and then \u003ci\u003ere-create\u003c/i\u003e symlinks).\u003c/summary\u003e\n\n  ```\n  stow-restow dotfiles user-dirs\n  ```\n  \n  \u003e  The *same effect* as when calling `stow-unstow` and then `stow-do`.\n\u003c/details\u003e\n\n---\n\nHappy **EasyStow**-ing your data! :tada:\n\n## Do you like EasyStow?\n\nFeel free to support my work:\n\n| Cryptocurrency | Address |\n| --- | --- |\n| Bitcoin (BTC) | bc1qwf90w004z04v39emd3jj8q4ev4rdna739ecqj5 |\n| Ethereum (ETH)| 0xED726ADA8d6A4f908de77f689D918039b03a698C |\n| Ripple (XRP) |rH8CFA1QVaijiMBaL9FgbpTzu2rYsu3FgB |\n| TON / USDT on TON | UQCVsW7ygTvQWmf8xRwMST7AdfDzNxwrw0CYkThEfhA5Xsk6 |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdbzix%2FEasyStow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdbzix%2FEasyStow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdbzix%2FEasyStow/lists"}