{"id":50513786,"url":"https://github.com/garrett-he/dotfiles","last_synced_at":"2026-06-02T22:01:46.412Z","repository":{"id":351324306,"uuid":"1083241479","full_name":"garrett-he/dotfiles","owner":"garrett-he","description":"This repository contains a collection of configuration files (aka dot files) and installer scripts for various utilities working in POSIX environments.","archived":false,"fork":false,"pushed_at":"2026-04-14T13:52:44.000Z","size":1225,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-14T15:33:52.977Z","etag":null,"topics":["dotfiles","git","shell","vim"],"latest_commit_sha":null,"homepage":"","language":"Vim Script","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/garrett-he.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":"AGENTS.md","dco":null,"cla":null}},"created_at":"2025-10-25T16:15:02.000Z","updated_at":"2026-04-14T13:52:50.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/garrett-he/dotfiles","commit_stats":null,"previous_names":["garrett-he/dotfiles"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/garrett-he/dotfiles","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/garrett-he%2Fdotfiles","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/garrett-he%2Fdotfiles/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/garrett-he%2Fdotfiles/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/garrett-he%2Fdotfiles/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/garrett-he","download_url":"https://codeload.github.com/garrett-he/dotfiles/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/garrett-he%2Fdotfiles/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33838221,"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-02T02:00:07.132Z","response_time":109,"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":["dotfiles","git","shell","vim"],"created_at":"2026-06-02T22:01:41.704Z","updated_at":"2026-06-02T22:01:46.407Z","avatar_url":"https://github.com/garrett-he.png","language":"Vim Script","funding_links":[],"categories":[],"sub_categories":[],"readme":"![logo](./images/dotfiles-logo.png)\n\n# dotfiles\n\n[简体中文](./README_zhCN.md)\n\nThis repository contains a collection of configuration files (aka dot files) and\ninstaller scripts for various utilities working in POSIX environments.\n\n## Installation\n\n`dotfiles` can be installed by running the following command in your terminal:\n\n```\ncurl -fsSL https://raw.githubusercontent.com/garrett-he/dotfiles/main/remote-install.sh | bash\n```\n\nIf you are installing through a mirror repository, you can set the environment\nvariable `DOTFILES_GIT_REMOTE`, then execute the command like:\n\n```\nDOTFILES_GIT_REMOTE=url/to/your/repo.git curl -fsSL https://url/to/your/repo/remote-install.sh | bash\n```\n\nAlternatively, you can clone this repository on your local machine and install\nit manually:\n\n```\ngit clone https://github.com/garrett-he/dotfiles.git ~/.dotfiles\nbash ~/.dotfiles/install.sh\n```\n\n## Modules\n\n`dotfiles` modules are located in the directory `/modules` as sub-folders. And\nthere should be at least one file named `setup.sh` with an implementation of\nfunction `setup()` to tell the global installer how to install this module.\n\nThe `setup.sh` can invoke all functions in `functions.sh` as well.\n\n## Configurations\n\nYou can create a file named `config` at root directory of this repository to\ntell the script how to perform installation.\n\nThe option `INSTALL_{MODULE}` is used to tell the installer whether to install\nthe module named `MODULE` (`1/Y/n` install, `0/N/n` skip) without confirmation.\n\n\u003e Essentially, configuration options are global environment variables, so you\n\u003e can also set these environment variables directly without generate `config`\n\u003e file before installation.\n\u003e\n\u003e This would be very useful for automatic `dotfiles` installation by other\n\u003e scripts.\n\nExample:\n\n```\n# install git without confirmation\nINSTALL_GIT=1\n\n# skip vim installation\nINSTALL_VIM=0\n```\n\n### Module options\n\nSome modules can also set installation options through `/config`, which to\nsupport automatic installation without keyboard input. Option names typically\nstart with `{MODULE}_`.\n\nAvailable module configurations:\n\n#### module: git\n\n```\n# git config user.name\nGIT_USER_NAME=YOUR_NAME\n\n# git config user.email\nGIT_USER_EMAIL=YOUR_EMAIL\n\n# git config init.defaultBranch\nGIT_INIT_DEFAULTBRANCH=main\n\n# git config commit.gpgsign\nGIT_COMMIT_GPGSIGN=0\n\n# git config user.signingkey\n# works only if git_commit_gpgsign=1\nGIT_USER_SIGNINGKEY=\n```\n\n## License\n\nCopyright (C) 2025 Garrett HE \u003cgarrett.he@outlook.com\u003e\n\nThe BSD 3-Clause License, see [LICENSE](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgarrett-he%2Fdotfiles","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgarrett-he%2Fdotfiles","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgarrett-he%2Fdotfiles/lists"}