{"id":15898677,"url":"https://github.com/jeffrey-xiao/dotinstall","last_synced_at":"2025-08-14T10:33:16.922Z","repository":{"id":46387115,"uuid":"90429781","full_name":"jeffrey-xiao/dotinstall","owner":"jeffrey-xiao","description":null,"archived":false,"fork":false,"pushed_at":"2022-12-08T12:37:21.000Z","size":1066,"stargazers_count":1,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-28T05:36:27.031Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jeffrey-xiao.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-05-06T01:42:28.000Z","updated_at":"2021-10-18T00:54:43.000Z","dependencies_parsed_at":"2022-09-26T17:51:27.857Z","dependency_job_id":null,"html_url":"https://github.com/jeffrey-xiao/dotinstall","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeffrey-xiao%2Fdotinstall","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeffrey-xiao%2Fdotinstall/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeffrey-xiao%2Fdotinstall/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeffrey-xiao%2Fdotinstall/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jeffrey-xiao","download_url":"https://codeload.github.com/jeffrey-xiao/dotinstall/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229821752,"owners_count":18129424,"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":[],"created_at":"2024-10-06T10:07:22.776Z","updated_at":"2024-12-15T12:41:09.093Z","avatar_url":"https://github.com/jeffrey-xiao.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dotinstall\n\n[![Build Status](https://travis-ci.org/travis-ci/travis-web.svg?branch=master)](https://travis-ci.org/travis-ci/travis-web) [![codecov](https://codecov.io/gh/jeffrey-xiao/dotinstall/branch/master/graph/badge.svg)](https://codecov.io/gh/jeffrey-xiao/dotinstall)\n[![PyPI version](https://badge.fury.io/py/dotinstall.svg)](https://badge.fury.io/py/dotinstall)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\n`dotinstall` makes it easier to completely setup a fresh install. By grouping your configs into\n'packages', you can use `dotinstall` to quickly symlink your files, install dependencies, and setup\nyour system. You might have a particularly hard time setting up your windows manager. For example, I\nuse i3-gaps and i3blocks-gaps on Ubuntu so I have to install those from source. By having a package\ndefined as i3, I can associate dependencies and scripts to run to setup my windows manager.\n\nFeatures:\n\n- Easy integration into existing dotfiles by installing as submodules.\n- Association of dependencies with packages.\n- Globbing for specifying targets to symlink in each package.\n- Prelink, and postlink scripts to run before symlinking and dependency installation.\n- Easy configuration setup using yaml.\n\n## Installation\n\n```\nmkdir dotfiles\ncd dotfiles\npip3 install dotinstall\ndotinstall\n```\n\n## Usage\n\nRun `dotinstall -h` for more details.\n\n## Config File\n\nThe config file (default `config.yaml`) has the following possible entries.\n\n**link**: If specified as an item, it will link all the items in the package to the specified\nlocation. If specified as a list, it will link the specific items to their specified location. Note\nthat each item will at most be linked once. For example, if you have three files `1.txt`,\n`2.txt`, `3.txt` and you first link `1.txt`, it will only link `2.txt` and\n`3.txt` when you later try to link `*.txt`.\n\n**prelink**: A list of scripts that will run before dependency installation and linking.\n\n**postlink**: A list of scripts that will run after dependency installation and linking.\n\n**dependencies**: A list of dependencies of each package that will be installed by the detected\npackage manager. Dependency installation will occur before linking.\n\n**overwrite**: If true (default), the symlinking will forcibly remove existing files, symlinks, and\ndirectories.\n\n**clean**: If true (default), dotinstall will remove all broken symlinks in all target directories.\n\nThe order of the commands will be: prelink -\u003e dependencies -\u003e link -\u003e postlink -\u003e clean.\n\nEach submodule will be installed in the order that it is listed in the config file.\n\n## Example\n\nPlease see my personal dotfile\n[config](https://github.com/jeffrey-xiao/dotfiles/blob/master/config.yaml).\n\n## Contributing\n\nPlease fork the repository and submit a PR. New plugins are very easy to create, by adding a new\nclass with a `execute` command.\n\nCurrently implemented package managers are:\n\n- `apt-get`\n- `brew`\n- `pacman`\n- `eopkg`\n\nFeel free to add other package managers.\n\n## License\n\n`dotinstall` is dual-licensed under the terms of either the MIT License or the Apache License\n(Version 2.0).\n\nSee [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeffrey-xiao%2Fdotinstall","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjeffrey-xiao%2Fdotinstall","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeffrey-xiao%2Fdotinstall/lists"}